LookupTypeName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getLookupTypeName

post

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

LookupTypeNameLookupTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getLookupTypeName

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LookupTypeName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLookupTypeName"
}

getLookupTypeNameSelectFields

post

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

LookupTypeNameLookupTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getLookupTypeNameSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "LookupTypeNameLookupType": 0,
  "SelectableFields": {
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": {
    "LookupType": 0,
    "LookupTypeValue": "Lookup Type 00"
  },
  "MessageId": "getLookupTypeNameSelectFields"
}

getLookupTypeNamePagedList

post

Retrieve LookupTypeName 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/getLookupTypeNamePagedList

HTTPcURLJavaScriptPython

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

{
  "LookupTypeName": [],
  "Token": null,
  "MessageId": "getLookupTypeNamePagedList"
}

getLookupTypeNameListSelectFields

post

Retrieve LookupTypeName 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/getLookupTypeNameListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LookupTypeNameList": [],
  "MessageId": "getLookupTypeNameListSelectFields"
}

searchLookupTypeNameSelectFields

post

Search LookupTypeName 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/searchLookupTypeNameSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LookupTypeNameList": [],
  "MessageId": "searchLookupTypeNameSelectFields"
}

getLookupTypeNamePagedListSelectFields

post

Retrieve LookupTypeName 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/getLookupTypeNamePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LookupTypeName": [
    {
      "LookupType": 0,
      "LookupTypeValue": "Lookup Type 00"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getLookupTypeNamePagedListSelectFields"
}

searchLookupTypeNamePagedSelectFields

post

Search LookupTypeName 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/searchLookupTypeNamePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LookupTypeName": [
    {
      "LookupType": 0,
      "LookupTypeValue": "Lookup Type 00"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchLookupTypeNamePagedSelectFields"
}

updateLookupTypeNameByID

post

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

LookupTypeNameLookupTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateLookupTypeNameByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateLookupTypeNameByID 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
      }
    }
  },
  "LookupTypeNameLookupType": 1,
  "LookupTypeNameUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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