Get List by Id
Returns a list record by its id.
Parameters
Path 1
listId integer (int32) requiredId of the static list to retrieve records from
Responses
200 OK ResponseOfStaticList
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of StaticList required
Array of results for individual records in the operation, may be empty
Model StaticList
createdAt string required Datetime when the list was created
description string Description of the static list
id integer (int32) required Unique integer id of the static list
name string required Name of the static list
programName string Name of the program
updatedAt string required Datetime when the list was most recently updated
workspaceName string Name of the parent workspace, if applicable
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"createdAt": "string",
"description": "string",
"id": 123,
"name": "Example name",
"programName": "Example name",
"updatedAt": "string",
"workspaceName": "Example name"
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.