LookupTypeName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getLookupTypeName

post

Retrieve lookup type name

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: 153

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupTypeNameLookupType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": {
    "LookupType": 1,
    "LookupTypeValue": "text"
  }
}

getLookupTypeNameSelectFields

post

Retrieve lookup type name select fields

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: 278

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupTypeNameLookupType": 1,
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true,
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": {
    "LookupType": 1,
    "LookupTypeValue": "text"
  }
}

getLookupTypeNamePagedList

post

Retrieve paged list of lookup type names

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": [
    {
      "LookupType": 1,
      "LookupTypeValue": "text"
    }
  ],
  "Token": "text"
}

getLookupTypeNameListSelectFields

post

Retrieve lookup type name list select fields

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: 249

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true,
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeNameList": {
    "hasReachedMaximumListSize": true,
    "LookupTypeName": [
      {
        "LookupType": 1,
        "LookupTypeValue": "text"
      }
    ]
  }
}

searchLookupTypeNameSelectFields

post

Retrieve a list of select fields for searching by lookup type names.

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: 281

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true,
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeNameList": {
    "hasReachedMaximumListSize": true,
    "LookupTypeName": [
      {
        "LookupType": 1,
        "LookupTypeValue": "text"
      }
    ]
  }
}

getLookupTypeNamePagedListSelectFields

post

Retrieve paged list select fields of lookup type names

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

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: 343

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true,
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": [
    {
      "LookupType": 1,
      "LookupTypeValue": "text"
    }
  ],
  "Token": "text"
}

searchLookupTypeNamePagedSelectFields

post

Retrieve a list of paged select fields for searching by lookup type names.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

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: 358

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllLookupTypeNameFields": true,
    "LookupTypeNameFields": {
      "LookupType": true,
      "LookupTypeValue": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupTypeName": [
    {
      "LookupType": 1,
      "LookupTypeValue": "text"
    }
  ],
  "Token": "text"
}

updateLookupTypeNameByID

post

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: 212

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LookupTypeNameLookupType": 1,
  "LookupTypeNameUpdatableFields": {
    "LookupTypeValue": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}