ItcInstallation

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getItcInstallation

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ItcInstallationItcInstallationintegerRequired

Responses

200

Successful operation.

application/json

post/getItcInstallation

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "ItcInstallationItcInstallation": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ItcInstallation": {
    "DefinedCode": 0,
    "ItcEnabled": false,
    "ItcInstallation": 0,
    "TargetPath": null,
    "TimeOutinMinutes": 0,
    "VoidEnabled": false
  },
  "MessageId": "getItcInstallation"
}

getItcInstallationSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ItcInstallationItcInstallationintegerOptional

Responses

200

Successful operation.

application/json

post/getItcInstallationSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "ItcInstallationItcInstallation": 0,
  "SelectableFields": {
    "ItcInstallationFields": {
      "ItcInstallation": true,
      "DefinedCode": true,
      "ItcEnabled": true
    }
  }
}

200

Successful operation.

{
  "ItcInstallation": {
    "DefinedCode": 0,
    "ItcEnabled": false,
    "ItcInstallation": 0
  },
  "MessageId": "getItcInstallationSelectFields"
}

getItcInstallationPagedList

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getItcInstallationPagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ItcInstallation": [],
  "Token": null,
  "MessageId": "getItcInstallationPagedList"
}

getItcInstallationListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getItcInstallationListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true
  }
}

200

Successful operation.

{
  "ItcInstallationList": [],
  "MessageId": "getItcInstallationListSelectFields"
}

searchItcInstallationSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchItcInstallationSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ItcInstallationList": [],
  "MessageId": "searchItcInstallationSelectFields"
}

getItcInstallationPagedListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getItcInstallationPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "ItcInstallationFields": {
      "ItcInstallation": true,
      "DefinedCode": true,
      "ItcEnabled": true
    }
  }
}

200

Successful operation.

{
  "ItcInstallation": [
    {
      "DefinedCode": 0,
      "ItcEnabled": false,
      "ItcInstallation": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getItcInstallationPagedListSelectFields"
}

searchItcInstallationPagedSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchItcInstallationPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "ItcInstallationFields": {
      "ItcInstallation": true,
      "DefinedCode": true,
      "ItcEnabled": true
    }
  }
}

200

Successful operation.

{
  "ItcInstallation": [
    {
      "DefinedCode": 0,
      "ItcEnabled": false,
      "ItcInstallation": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchItcInstallationPagedSelectFields"
}

updateItcInstallationByID

post

Update ItcInstallation parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ItcInstallationItcInstallationintegerOptional

Responses

200

Successful operation.

application/json

post/updateItcInstallationByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "ItcInstallationItcInstallation": 1,
  "ItcInstallationUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateItcInstallationByID"
}