/api/stations/v1/station-groups
- 22 Aug 2024
- 7 Minutes to read
- Contributors
- Print
/api/stations/v1/station-groups
- Updated on 22 Aug 2024
- 7 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/stations/v1/station-groups
Gets a paginated, filtered, and sorted list of station groups.
Query parameters
limit
integer
Limits the number of station groups listed.
Minimum0
Example1
offset
integer
Returns documents after a certain offset. Use with limit to paginate the response.
Minimum0
Example0
filter
string
Filters the result by parentStationGroupId using OData 4.01 syntax, where parentId is a valid station group id or null. Only supports the eq operator.
sort
string
Sorts the result by 'name', 'lastModified.at', and 'created.at'. Seperate by a comma. Specify descending sort with a '-' character.
search
string
Searches for station groups by name.
archived
boolean
Filters station groups by whether they are archived. If not provided, defaults to false and only non-archived station groups will be included in the response.
Responses
200
A paginated list of station groups.
object
items
Array of object (StationGroup)
object
Represents a station group.
Example{ "id": "swM2aGebq5MjhKafN", "name": "Boston", "description": "Contains all the stations in the Boston factory.", "appAssignments": [ { "id": "78M2aGebq5MjhKafN", "type": "app-folder", "tag": "latest-published", "appFolderId": "12M2aGebq5MjhKafN" } ], "created": { "at": "2023-03-08T12:17:24Z", "by": { "id": "90M2aGebq5MjhKafN", "type": "user" } }, "lastModified": { "at": "2023-03-08T12:17:24Z", "by": { "id": "90M2aGebq5MjhKafN", "type": "user" } }, "workspaces": { "scope": "specific", "workspaceIds": [ "56M2aGebq5MjhKafN" ] } }
id
Exampleg56RCoZCtzv7borvp
name
string
The name of the station group.
parentId
Exampleg56RCoZCtzv7borvp
description
string
A short description of the station group.
created
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
lastModified
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
archived
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
workspaces
object (WorkspaceMembership)
A description of the workspaces of which a resource is a member. Workspace membership can have one of two scope values. A scope of all means that a resource is a member of all current and future workspaces. A scope of the value specific means that a resource is a member of a set of particular workspaces as described by the workspaceIds property.
Example{ "scope": "specific", "workspaceIds": [ "DEFAULT" ] }
OneOf
AllWorkspacesMembership
scope
string
Describes a resource as a member of all current and future workspaces.
Valid values[ "all" ]
Exampleall
SpecificWorkspacesMembership
scope
string
Describes a resource as a member of a set of specific workspaces.
Valid values[ "specific" ]
Examplespecific
workspaceIds
Array of string (WorkspaceId)
The workspaces in which a resource is a member.
string
ExampleDEFAULT
count
number
The total number of items that matched the list parameters.
Example10
nextPage
string (url)
A URL at which the next page of results can be fetched.
prevPage
string (url)
A URL at which the previous page of results can be fetched.
items
Array
errors
Array of object (PaginatedItemError)
A list of errors per item that is omitted from the paginated response, if any.
object
Example{ "errorCode": "generic.internal", "message": "Something went wrong.", "retryable": false, "details": { "id": "invalidRecordId" } }
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
retryable
Valid values[ "False" ]
details
object
id
string
The ID of the omitted record.
400
An error occurred. The Tulip error codes generic.customerIdRequired, generic.workspaceIdRequired, generic.invalidParams, http.invalidBodyJson, http.invalidHeaders, http.multiValueHeader, generic.limitParamNonNegativeInt, generic.limitParamBounds, generic.offsetParamNonNegativeInt, generic.sortParamUnsupportedField, generic.filterParamUnsupportedOperation, and generic.filterParamUnsupportedField all use the 400 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.
OneOf
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.customerIdRequired" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.workspaceIdRequired" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.invalidParams" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.invalidBodyJson" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.invalidHeaders" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.multiValueHeader" ]
details
object
headerName
string
The name of the given HTTP header which had multiple values.
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.limitParamNonNegativeInt" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.limitParamBounds" ]
details
object
upperBound
integer
The maximum allowed value for the limit parameter.
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.offsetParamNonNegativeInt" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.sortParamUnsupportedField" ]
details
object
unsupportedFields
Array of string
The names of the given fields which are not supported.
string
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.filterParamUnsupportedOperation" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.filterParamUnsupportedField" ]
retryable
Valid values[ "False" ]
401
The request was missing required authentication information.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.authRequired" ]
retryable
Valid values[ "False" ]
429
Too many requests have been made to this endpoint in a short time period.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.endpointRateLimitExceeded" ]
details
object
details
string
Additional details about this endpoint's rate limits.
retryable
Valid values[ "False" ]
500
An error occurred. The Tulip error codes generic.internal and stations.internalTypeValidationError both use the 500 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.
OneOf
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.internal" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "stations.internalTypeValidationError" ]
details
object
resourceName
string
The name of the resource that failed validation.
resourceId
string
The id of the resource that failed validation.
retryable
Valid values[ "False" ]
Was this article helpful?
