SymXInstance

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXInstance

post

Retrieve SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

SymXInstanceInstanceIdintegerRequired

Responses

200

Successful operation.

application/json

post/getSymXInstance

POST /nexum/627/2022.01/parameter/getSymXInstance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXInstanceInstanceId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXInstance": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXInstance"
}

getSymXInstanceSelectFields

post

Retrieve SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

SymXInstanceInstanceIdintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXInstanceSelectFields

POST /nexum/627/2022.01/parameter/getSymXInstanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true
  }
}

200

Successful operation.

{
  "SymXInstance": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXInstanceSelectFields"
}

getSymXInstancePagedList

post

Retrieve SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSymXInstancePagedList

POST /nexum/627/2022.01/parameter/getSymXInstancePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXInstance": [],
  "Token": null,
  "MessageId": "getSymXInstancePagedList"
}

getSymXInstanceListSelectFields

post

Retrieve SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getSymXInstanceListSelectFields

POST /nexum/627/2022.01/parameter/getSymXInstanceListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true
  }
}

200

Successful operation.

{
  "SymXInstanceList": [],
  "MessageId": "getSymXInstanceListSelectFields"
}

searchSymXInstanceSelectFields

post

Search SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchSymXInstanceSelectFields

POST /nexum/627/2022.01/parameter/searchSymXInstanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXInstanceList": [],
  "MessageId": "searchSymXInstanceSelectFields"
}

getSymXInstancePagedListSelectFields

post

Retrieve SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSymXInstancePagedListSelectFields

POST /nexum/627/2022.01/parameter/getSymXInstancePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "SymXInstanceFields": {
      "InstanceId": true,
      "Name": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "SymXInstance": [
    {
      "Description": "LIBUM",
      "InstanceId": 0,
      "Name": "LIBUM"
    }
  ],
  "Token": null,
  "MessageId": "getSymXInstancePagedListSelectFields"
}

searchSymXInstancePagedSelectFields

post

Search SymXInstance parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchSymXInstancePagedSelectFields

POST /nexum/627/2022.01/parameter/searchSymXInstancePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "SymXInstanceFields": {
      "InstanceId": true,
      "Name": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "SymXInstance": [
    {
      "Description": "LIBUM",
      "InstanceId": 0,
      "Name": "LIBUM"
    }
  ],
  "Token": null,
  "MessageId": "searchSymXInstancePagedSelectFields"
}