Tpt

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getTpt

post

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

TptPrinterintegerRequired

Responses

200

Successful operation.

application/json

post/getTpt

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "Tpt": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getTpt"
}

getTptSelectFields

post

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

TptPrinterintegerOptional

Responses

200

Successful operation.

application/json

post/getTptSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "TptPrinter": 0,
  "SelectableFields": {
    "TptFields": {
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true
    }
  }
}

200

Successful operation.

{
  "Tpt": {
    "Printer": 0,
    "PrinterType": 0,
    "QueueNumber": 0
  },
  "MessageId": "getTptSelectFields"
}

getTptPagedList

post

Retrieve Tpt 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/getTptPagedList

HTTPcURLJavaScriptPython

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

{
  "Tpt": [],
  "Token": null,
  "MessageId": "getTptPagedList"
}

getTptListSelectFields

post

Retrieve Tpt 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/getTptListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TptList": [],
  "MessageId": "getTptListSelectFields"
}

searchTptSelectFields

post

Search Tpt 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/searchTptSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "TptList": [],
  "MessageId": "searchTptSelectFields"
}

getTptPagedListSelectFields

post

Retrieve Tpt 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/getTptPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "TptFields": {
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true
    }
  }
}

200

Successful operation.

{
  "Tpt": [
    {
      "Printer": 0,
      "PrinterType": 0,
      "QueueNumber": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getTptPagedListSelectFields"
}

searchTptPagedSelectFields

post

Search Tpt 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/searchTptPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "TptFields": {
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true
    }
  }
}

200

Successful operation.

{
  "Tpt": [
    {
      "Printer": 0,
      "PrinterType": 0,
      "QueueNumber": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchTptPagedSelectFields"
}