UserTrackingType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getUserTrackingType

post

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

UserTrackingTypeRecordSelectionintegerOptional

UserTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getUserTrackingType

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingType": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getUserTrackingType"
}

getUserTrackingTypeSelectFields

post

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

UserTrackingTypeRecordSelectionintegerOptional

UserTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getUserTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "UserTrackingTypeRecordSelection": 3,
  "UserTrackingTypeTrackingType": 0,
  "SelectableFields": {
    "UserTrackingTypeFields": {
      "RecordSelection": true,
      "TrackingType": true,
      "Description": true
    }
  }
}

200

Successful operation.

{
  "UserTrackingType": {
    "Description": "Tracking Type 00",
    "RecordSelection": 3,
    "TrackingType": 0
  },
  "MessageId": "getUserTrackingTypeSelectFields"
}

getUserTrackingTypePagedList

post

Retrieve UserTrackingType 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/getUserTrackingTypePagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingType": [],
  "Token": null,
  "MessageId": "getUserTrackingTypePagedList"
}

getUserTrackingTypeListSelectFields

post

Retrieve UserTrackingType 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/getUserTrackingTypeListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingTypeList": [],
  "MessageId": "getUserTrackingTypeListSelectFields"
}

searchUserTrackingTypeSelectFields

post

Search UserTrackingType 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/searchUserTrackingTypeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingTypeList": [],
  "MessageId": "searchUserTrackingTypeSelectFields"
}

getUserTrackingTypePagedListSelectFields

post

Retrieve UserTrackingType 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/getUserTrackingTypePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingType": [
    {
      "Description": "Tracking Type 00",
      "RecordSelection": 0,
      "TrackingType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getUserTrackingTypePagedListSelectFields"
}

searchUserTrackingTypePagedSelectFields

post

Search UserTrackingType 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/searchUserTrackingTypePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserTrackingType": [
    {
      "Description": "Tracking Type 00",
      "RecordSelection": 0,
      "TrackingType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchUserTrackingTypePagedSelectFields"
}

updateUserTrackingTypeByID

post

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

UserTrackingTypeRecordSelectionintegerOptional

UserTrackingTypeTrackingTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateUserTrackingTypeByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "UserTrackingTypeRecordSelection": 1,
  "UserTrackingTypeTrackingType": 1,
  "UserTrackingTypeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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