GlTrackingType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getGlTrackingType

post

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

GlTrackingTypeRecordSelectionintegerOptional

GlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getGlTrackingType

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlTrackingType": {
    "Description": "Tracking Type 00",
    "ParentClosingOption": false,
    "RecordSelection": 5,
    "TrackingType": 0
  },
  "MessageId": "getGlTrackingType"
}

getGlTrackingTypeSelectFields

post

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

GlTrackingTypeRecordSelectionintegerOptional

GlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getGlTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "GlTrackingTypeRecordSelection": 5,
  "GlTrackingTypeTrackingType": 0,
  "SelectableFields": {
    "GlTrackingTypeFields": {
      "RecordSelection": true,
      "TrackingType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "GlTrackingType": {
    "Description": "Tracking Type 00",
    "ParentClosingOption": null,
    "RecordSelection": 5,
    "TrackingType": 0,
    "UserRate20": []
  },
  "MessageId": "getGlTrackingTypeSelectFields"
}

getGlTrackingTypePagedList

post

Retrieve GlTrackingType 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/getGlTrackingTypePagedList

HTTPcURLJavaScriptPython

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

{
  "GlTrackingType": [],
  "Token": null,
  "MessageId": "getGlTrackingTypePagedList"
}

getGlTrackingTypeListSelectFields

post

Retrieve GlTrackingType 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/getGlTrackingTypeListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlTrackingTypeList": [],
  "MessageId": "getGlTrackingTypeListSelectFields"
}

searchGlTrackingTypeSelectFields

post

Search GlTrackingType 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/searchGlTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlTrackingTypeList": [],
  "MessageId": "searchGlTrackingTypeSelectFields"
}

getGlTrackingTypePagedListSelectFields

post

Retrieve GlTrackingType 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/getGlTrackingTypePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlTrackingType": [
    {
      "Description": "Tracking Type 00",
      "ParentClosingOption": null,
      "RecordSelection": 0,
      "TrackingType": 0,
      "UserRate20": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getGlTrackingTypePagedListSelectFields"
}

searchGlTrackingTypePagedSelectFields

post

Search GlTrackingType 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/searchGlTrackingTypePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlTrackingType": [
    {
      "Description": "Tracking Type 00",
      "ParentClosingOption": null,
      "RecordSelection": 0,
      "TrackingType": 0,
      "UserRate20": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchGlTrackingTypePagedSelectFields"
}

updateGlTrackingTypeByID

post

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

GlTrackingTypeRecordSelectionintegerOptional

GlTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateGlTrackingTypeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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