InventoryDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInventoryDefault

post

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

InventoryDefaultInventoryTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getInventoryDefault

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "InventoryDefault": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInventoryDefault"
}

getInventoryDefaultSelectFields

post

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

InventoryDefaultInventoryTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getInventoryDefaultSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InventoryDefaultInventoryType": 0,
  "SelectableFields": {
    "InventoryDefaultFields": {
      "InventoryType": true,
      "Type": true,
      "Status": true
    }
  }
}

200

Successful operation.

{
  "InventoryDefault": {
    "InventoryType": 0,
    "Status": 0,
    "Type": 0
  },
  "MessageId": "getInventoryDefaultSelectFields"
}

getInventoryDefaultPagedList

post

Retrieve InventoryDefault 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/getInventoryDefaultPagedList

HTTPcURLJavaScriptPython

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

{
  "InventoryDefault": [],
  "Token": null,
  "MessageId": "getInventoryDefaultPagedList"
}

getInventoryDefaultListSelectFields

post

Retrieve InventoryDefault 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/getInventoryDefaultListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInventoryDefaultListSelectFields 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": {
    "IncludeAllInventoryDefaultFields": true
  }
}

200

Successful operation.

{
  "InventoryDefaultList": [],
  "MessageId": "getInventoryDefaultListSelectFields"
}

searchInventoryDefaultSelectFields

post

Search InventoryDefault 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/searchInventoryDefaultSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchInventoryDefaultSelectFields 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": {
    "IncludeAllInventoryDefaultFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryDefaultList": [],
  "MessageId": "searchInventoryDefaultSelectFields"
}

getInventoryDefaultPagedListSelectFields

post

Retrieve InventoryDefault 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/getInventoryDefaultPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InventoryDefaultFields": {
      "InventoryType": true,
      "Type": true,
      "Status": true
    }
  }
}

200

Successful operation.

{
  "InventoryDefault": [
    {
      "InventoryType": 0,
      "Status": 0,
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInventoryDefaultPagedListSelectFields"
}

searchInventoryDefaultPagedSelectFields

post

Search InventoryDefault 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/searchInventoryDefaultPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InventoryDefaultFields": {
      "InventoryType": true,
      "Type": true,
      "Status": true
    }
  }
}

200

Successful operation.

{
  "InventoryDefault": [
    {
      "InventoryType": 0,
      "Status": 0,
      "Type": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInventoryDefaultPagedSelectFields"
}

updateInventoryDefaultByID

post

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

InventoryDefaultInventoryTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateInventoryDefaultByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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