InventoryFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInventoryFieldName

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryFieldNameFieldintegerRequired

Responses

200

Successful operation.

application/json

post/getInventoryFieldName

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InventoryFieldNameField": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryFieldName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInventoryFieldName"
}

getInventoryFieldNameSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryFieldNameFieldintegerOptional

Responses

200

Successful operation.

application/json

post/getInventoryFieldNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InventoryFieldNameField": 1,
  "SelectableFields": {
    "InventoryFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "InventoryFieldName": {
    "Field": 1,
    "FieldName": "User Number 01"
  },
  "MessageId": "getInventoryFieldNameSelectFields"
}

getInventoryFieldNamePagedList

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryFieldNamePagedList

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryFieldName": [],
  "Token": null,
  "MessageId": "getInventoryFieldNamePagedList"
}

getInventoryFieldNameListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getInventoryFieldNameListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryFieldNameFields": true
  }
}

200

Successful operation.

{
  "InventoryFieldNameList": [],
  "MessageId": "getInventoryFieldNameListSelectFields"
}

searchInventoryFieldNameSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchInventoryFieldNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryFieldNameFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryFieldNameList": [],
  "MessageId": "searchInventoryFieldNameSelectFields"
}

getInventoryFieldNamePagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryFieldNamePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InventoryFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "InventoryFieldName": [
    {
      "Field": 1,
      "FieldName": "User Number 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInventoryFieldNamePagedListSelectFields"
}

searchInventoryFieldNamePagedSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchInventoryFieldNamePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InventoryFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "InventoryFieldName": [
    {
      "Field": 1,
      "FieldName": "User Number 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInventoryFieldNamePagedSelectFields"
}

updateInventoryFieldNameByID

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryFieldNameFieldintegerOptional

Responses

200

Successful operation.

application/json

post/updateInventoryFieldNameByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InventoryFieldNameField": "example-value",
  "InventoryFieldNameUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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