/api/stations/v1/station-groups/{stationGroupId}/stations
- 22 Aug 2024
- 4 Minutes to read
- Contributors
- Print
/api/stations/v1/station-groups/{stationGroupId}/stations
- Updated on 22 Aug 2024
- 4 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/api/stations/v1/station-groups/{stationGroupId}/stations
Updates the list of stations in a station group.
Path parameters
stationGroupId
Required
The id of the station group that the stations will be updated for.
Exampleg56RCoZCtzv7borvp
Body parameters
A directive containing the list of stations to add to the group or remove from it.
object
Information necessary to add a station to a list of stations or remove the station from it.
Example{ "add": [ "swM2aGebq5MjhKafN" ], "remove": [ "DFX2aFe124MjhFaRt" ] }
add
Array of object (StationId)
An array station IDs to add
Exampleg56RCoZCtzv7borvp
remove
Array of object (StationId)
An array of station IDs to remove
Exampleg56RCoZCtzv7borvp
Responses
204
The stations were successfully updated in the station group.
400
An error occurred. The Tulip error codes generic.customerIdRequired, generic.workspaceIdRequired, generic.invalidParams, http.invalidBodyJson, http.invalidHeaders, and http.multiValueHeader 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" ]
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" ]
404
The requested resource was not found.
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.notFound" ]
retryable
Valid values[ "False" ]
422
An error occurred. The Tulip error codes generic.archivedResourceUnsupportedOperation, stations.invalidReferencedResourceId, and stations.stationGroupStationsLimitReached all use the 422 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.archivedResourceUnsupportedOperation" ]
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.invalidReferencedResourceId" ]
details
Array of object
A list of invalid referenced resources.
object
resourceId
string
The id of the invalid resource.
details
string
Details about why the resource was invalid.
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.stationGroupStationsLimitReached" ]
details
object
workspaceId
string
stationGroupId
string
limit
number
The limit of how many stations can be in the station group.
current
number
The current number of stations in the station group.
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 internal server error occurred. Please contact support@tulip.co if the error persists.
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.internal" ]
retryable
Valid values[ "False" ]
Was this article helpful?
