Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
No description provided.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getItcInstallation HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 159 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ItcInstallationItcInstallation": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "ItcInstallation": { "DefinedCode": 1, "ItcEnabled": true, "ItcInstallation": 1, "TargetPath": "text", "TimeOutinMinutes": 1, "VoidEnabled": true } }
POST /nexum/627/2022.01/parameter/getItcInstallationSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 366 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ItcInstallationItcInstallation": 1, "SelectableFields": { "IncludeAllItcInstallationFields": true, "ItcInstallationFields": { "DefinedCode": true, "ItcEnabled": true, "ItcInstallation": true, "TargetPath": true, "TimeOutinMinutes": true, "VoidEnabled": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getItcInstallationPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 218 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ItcInstallation": [ { "DefinedCode": 1, "ItcEnabled": true, "ItcInstallation": 1, "TargetPath": "text", "TimeOutinMinutes": 1, "VoidEnabled": true } ], "Token": "text" }
POST /nexum/627/2022.01/parameter/getItcInstallationListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 331 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllItcInstallationFields": true, "ItcInstallationFields": { "DefinedCode": true, "ItcEnabled": true, "ItcInstallation": true, "TargetPath": true, "TimeOutinMinutes": true, "VoidEnabled": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ItcInstallationList": { "hasReachedMaximumListSize": true, "ItcInstallation": [ { "DefinedCode": 1, "ItcEnabled": true, "ItcInstallation": 1, "TargetPath": "text", "TimeOutinMinutes": 1, "VoidEnabled": true } ] } }
Retrieve a list of select fields for searching by ITC installation information.
POST /nexum/627/2022.01/parameter/searchItcInstallationSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 363 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllItcInstallationFields": true, "ItcInstallationFields": { "DefinedCode": true, "ItcEnabled": true, "ItcInstallation": true, "TargetPath": true, "TimeOutinMinutes": true, "VoidEnabled": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getItcInstallationPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 425 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllItcInstallationFields": true, "ItcInstallationFields": { "DefinedCode": true, "ItcEnabled": true, "ItcInstallation": true, "TargetPath": true, "TimeOutinMinutes": true, "VoidEnabled": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve a list of paged select fields for searching by ITC installation information.
POST /nexum/627/2022.01/parameter/searchItcInstallationPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 440 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllItcInstallationFields": true, "ItcInstallationFields": { "DefinedCode": true, "ItcEnabled": true, "ItcInstallation": true, "TargetPath": true, "TimeOutinMinutes": true, "VoidEnabled": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Updatable fields for ITC installation
POST /nexum/627/2022.01/parameter/updateItcInstallationByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 288 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "ItcInstallationItcInstallation": 1, "ItcInstallationUpdatableFields": { "DefinedCode": 1, "ItcEnabled": true, "TargetPath": "text", "TimeOutinMinutes": 1, "VoidEnabled": true }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
