/api/stations/v1/station-groups/{stationGroupId}
- 17 Oct 2024
- 6 Minutes to read
- Contributors
- Print
/api/stations/v1/station-groups/{stationGroupId}
- Updated on 17 Oct 2024
- 6 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}
Updates a station group.
Path parameters
stationGroupId
Required
The id of the station group to update.
Exampleg56RCoZCtzv7borvp
Body parameters
The fields to update for the station group.
object
Used to create update an existing station group.
Example{ "name": "Boston", "description": "Contains all the stations in the Boston factory." }
name
string
The name of the station group.
Max length500
description
string
A short description of the station group.
Max length5000
Responses
200
The station group was updated successfully.
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", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ]
id
Exampleg56RCoZCtzv7borvp
lastModified
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ]
id
Exampleg56RCoZCtzv7borvp
archived
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ]
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" ] }
#content#
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
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.
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.
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.
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.
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.
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.
details
object
headerName
string
The name of the given HTTP header which had multiple values.
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.
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.
409
Resource with this name already exists in the workspace.
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.
details
object
name
string
type
string
422
An error occurred. The Tulip error codes generic.archivedResourceUnsupportedOperation, stations.invalidResourceDescription, and stations.invalidResourceName 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.
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.
details
object
reason
string
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.
details
object
reason
string
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.
details
object
details
string
Additional details about this endpoint's rate limits.
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.
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.
details
object
resourceName
string
The name of the resource that failed validation.
resourceId
string
The id of the resource that failed validation.
Was this article helpful?
