/api/stations/v1/station-groups/{stationGroupId}/app-assignments/{appAssignmentId}
- 17 Oct 2024
- 4 Minutes to read
- Contributors
- Print
/api/stations/v1/station-groups/{stationGroupId}/app-assignments/{appAssignmentId}
- Updated on 17 Oct 2024
- 4 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Put
/api/stations/v1/station-groups/{stationGroupId}/app-assignments/{appAssignmentId}
Updates a specific app assignment for a station group.
Path parameters
stationGroupId
Required
The id of the station group to update.
Exampleg56RCoZCtzv7borvp
appAssignmentId
Required
The id of the app assignment to update.
Exampleg56RCoZCtzv7borvp
Body parameters
The fields to update an app assignment.
object
Represents the contents of a single app assignment.
Example{ "type": "app", "tag": "development", "appId": "swM2aGebq5MjhKafN" }
#content#
OneOf
AllAppAssignment
type
string Required
Valid values[ "all" ]
Default"all"
tag
string Required
The tag of an app assignment. Determines if the app assignment refers to the development version of an app or the latest production version.
Valid values[ "development", "latest-published" ]
FolderAppAssignment
type
string Required
Valid values[ "app-folder" ]
Default"app-folder"
tag
string Required
The tag of an app assignment. Determines if the app assignment refers to the development version of an app or the latest production version.
Valid values[ "development", "latest-published" ]
appFolderId
Exampleg56RCoZCtzv7borvp
SpecificAppAssignment
type
string Required
Valid values[ "app" ]
Default"app"
tag
string Required
The tag of an app assignment. Determines if the app assignment refers to the development version of an app or the latest production version.
Valid values[ "development", "latest-published" ]
appId
Exampleg56RCoZCtzv7borvp
VersionAppAssignment
type
string Required
Valid values[ "app-version" ]
Default"app-version"
appVersionId
Exampleg56RCoZCtzv7borvp
Responses
200
The app assignment was successfully updated.
object
App assignments are added to stations and station groups to restrict what apps are allowed to run at respective stations.
Example{ "id": "12M2aGebq5MjhKafN", "type": "app", "tag": "development", "appId": "swM2aGebq5MjhKafN" }
id
Exampleg56RCoZCtzv7borvp
OneOf
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
Conflicting app assignment detected. Only one app assignment can be specified for a specific app, app folder or all apps.
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
appAssignmentKind
string
422
An error occurred. The Tulip error codes generic.archivedResourceUnsupportedOperation and stations.invalidReferencedResourceId both 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
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.
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 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.
Was this article helpful?
