BatchRc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getBatchRc

post

Retrieve BatchRc 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

BatchRcBatchReturnCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getBatchRc

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "BatchRc": {
    "BatchReturnCodeDefinedType": 0,
    "BatchReturnCodeDescription": "Fatal",
    "BatchReturnCode": 1
  },
  "MessageId": "getBatchRc"
}

getBatchRcSelectFields

post

Retrieve BatchRc 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

BatchRcBatchReturnCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getBatchRcSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "BatchRc": {
    "BatchReturnCode": 0,
    "BatchReturnCodeDefinedType": 0,
    "BatchReturnCodeDescription": "Job successful"
  },
  "MessageId": "getBatchRcSelectFields"
}

getBatchRcPagedList

post

Retrieve BatchRc 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/getBatchRcPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getBatchRcPagedList 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.

{
  "BatchRc": [],
  "Token": null,
  "MessageId": "getBatchRcPagedList"
}

getBatchRcListSelectFields

post

Retrieve BatchRc 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/getBatchRcListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "BatchRcList": [],
  "MessageId": "getBatchRcListSelectFields"
}

searchBatchRcSelectFields

post

Search BatchRc 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/searchBatchRcSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "BatchRcList": [],
  "MessageId": "searchBatchRcSelectFields"
}

getBatchRcPagedListSelectFields

post

Retrieve BatchRc 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/getBatchRcPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "BatchRc": [
    {
      "BatchReturnCode": 0,
      "BatchReturnCodeDefinedType": 0,
      "BatchReturnCodeDescription": "Job successful"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getBatchRcPagedListSelectFields"
}

searchBatchRcPagedSelectFields

post

Search BatchRc 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/searchBatchRcPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchBatchRcPagedSelectFields 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"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllBatchRcFields": true
  }
}

200

Successful operation.

{
  "BatchRc": [
    {
      "BatchReturnCode": 0,
      "BatchReturnCodeDefinedType": 0,
      "BatchReturnCodeDescription": "Job successful"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchBatchRcPagedSelectFields"
}

updateBatchRcByID

post

Update BatchRc 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

BatchRcBatchReturnCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateBatchRcByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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