Update Collection
put
/mobile/tools/1.0/collections/{id}
Updates the storage collection's metadata.
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
string
Required:true
The identifier of the storage collection.
Header Parameters
- If-Match
-
Type:
string
The request completes successfully only if the ETag of the corresponding asset matches the value of this HTTP request header. To force overwrite, pass the value `*`.
Body Parameter
The storage collection representation for PUT requests.
Root Schema : mosCollectionUpdate
Type:
object
The storage collection representation for PUT requests.
-
Type:
object
assetUpdateAdditional Properties Allowed:The asset representation for PUT requests. -
Type:
object
mosCollectionUpdate-allOf[1]Additional Properties Allowed:
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
- actionComment
-
Type:
string
- desc
-
Type:
string
Maximum Length:100
- max
-
Type:
boolean
Default Value:false
- name
-
Type:
string
Required:true
Maximum Length:100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
- namespace
-
Type:
string
Applicable to APIs and implementations only. This value is null for all other asset types. - title
-
Type:
string
Maximum Length:255
- version
-
Type:
string
Maximum Length:100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : mosCollectionUpdate-allOf[1]
- syncControl
-
Type:
boolean
- userIsolated
-
Type:
boolean
Response
Supported Media Types
- application/json
204 Response
The storage collection metadata was updated. No content was returned in the response.
400 Response
The storage collection specification is missing.
Body
Root Schema : error
Type:
object
- detail
-
Type:
string
Required:true
Message that provides the error details. - o:ecid
-
Type:
string
Required:true
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components. - o:errorCode
-
Type:
string
Required:true
The service's error code. - o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - o:errorPath
-
Type:
string
Required:true
The relative point in the API path where the error occurred. - status
-
Type:
integer
(int64
)Required:true
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details. - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
object
- detail
-
Type:
string
Required:true
- o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.
409 Response
A storage collection already exists with the same name as the modified name.
Body
Root Schema : error
Type:
object
- detail
-
Type:
string
Required:true
Message that provides the error details. - o:ecid
-
Type:
string
Required:true
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components. - o:errorCode
-
Type:
string
Required:true
The service's error code. - o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - o:errorPath
-
Type:
string
Required:true
The relative point in the API path where the error occurred. - status
-
Type:
integer
(int64
)Required:true
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details. - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
object
- detail
-
Type:
string
Required:true
- o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.
412 Response
The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. It also can be the result of improper values specified in the request headers.
Body
Root Schema : error
Type:
object
- detail
-
Type:
string
Required:true
Message that provides the error details. - o:ecid
-
Type:
string
Required:true
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components. - o:errorCode
-
Type:
string
Required:true
The service's error code. - o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - o:errorPath
-
Type:
string
Required:true
The relative point in the API path where the error occurred. - status
-
Type:
integer
(int64
)Required:true
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details. - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
object
- detail
-
Type:
string
Required:true
- o:errorDetails
-
Type:
object
errorDetailsAdditional Properties Allowed: - title
-
Type:
string
Required:true
Summary of the problem. - type
-
Type:
string
Required:true
The URI to the link that provides details about the HTTP status code.