LookupTypeName⁠

Perform various operations for Symitar parameters.

Operations⁠

getLookupTypeName⁠

POST

Retrieve LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

LookupTypeNameLookupTypeintegerrequired

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/parameter/getLookupTypeName

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupTypeNameLookupType": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getLookupTypeNameSelectFields⁠

POST

Retrieve LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

LookupTypeNameLookupTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/parameter/getLookupTypeNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "LookupTypeNameLookupType": 0,
  "SelectableFields": {
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  }
}

getLookupTypeNamePagedList⁠

POST

Retrieve LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/parameter/getLookupTypeNamePagedList

POST /nexum/627/2022.01/parameter/getLookupTypeNamePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "REPLACE_WITH_YOUR_TOKEN"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getLookupTypeNameListSelectFields⁠

POST

Retrieve LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/parameter/getLookupTypeNameListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true
  }
}

searchLookupTypeNameSelectFields⁠

POST

Search LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/parameter/searchLookupTypeNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getLookupTypeNamePagedListSelectFields⁠

POST

Retrieve LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/parameter/getLookupTypeNamePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  }
}

searchLookupTypeNamePagedSelectFields⁠

POST

Search LookupTypeName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Querystringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/parameter/searchLookupTypeNamePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "string",
  "SelectableFields": {
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  }
}

updateLookupTypeNameByID⁠

POST

Update LookupTypeName parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

LookupTypeNameLookupTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/parameter/updateLookupTypeNameByID

POST /nexum/627/2022.01/parameter/updateLookupTypeNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupTypeNameLookupType": 0,
  "LookupTypeNameUpdatableFields": {
    "Type": 0,
    "Description": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}