SymXClient

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXClient

post

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

SymXClientInstanceIdintegerOptional

SymXClientSymXClientNumberintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXClient

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SymXClientInstanceId": 1,
  "SymXClientSymXClientNumber": "NEXW45",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXClient": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXClient"
}

getSymXClientSelectFields

post

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

SymXClientInstanceIdintegerOptional

SymXClientSymXClientNumberintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXClientSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSymXClientSelectFields 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": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXClientFields": true
  }
}

200

Successful operation.

{
  "SymXClient": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXClientSelectFields"
}

updateSymXClientByID

post

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

SymXClientInstanceIdintegerOptional

SymXClientSymXClientNumberintegerOptional

Responses

200

Successful operation.

application/json

post/updateSymXClientByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SymXClientInstanceId": 1,
  "SymXClientSymXClientNumber": "NEXW45",
  "SymXClientUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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