Add Collection
post
/mobile/tools/1.0/collections
Creates a storage collection in the asset catalog.
Request
Supported Media Types
- application/json
The storage collection representation for POST requests.
Root Schema : mosCollectionCreate
Type:
object
The storage collection representation for POST requests.
Match All
Show Source
-
object assetCreate
The asset representation for POST requests.
-
object mosCollectionCreate-allOf[1]
Nested Schema : assetCreate
Type:
object
The asset representation for POST requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object assetCreate-allOf[1]
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetCreate-allOf[1]
Type:
Show Source
object
-
max(optional):
boolean
Default Value:
false
Response
Supported Media Types
- application/json
201 Response
The collection was created, and the metadata for the new collection was returned.
Headers
-
ETag: string
The ETag corresponds to the state of the collection (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.
-
Location: string
URL to get to get the details about the new storage collection.
The storage collection representation for GET requests.
Root Schema : mosCollectionGet
Type:
object
The storage collection representation for GET requests.
Match All
Show Source
-
object assetGet
The asset representation for GET requests.
-
object mosCollectionGet-allOf[1]
Nested Schema : assetGet
Type:
object
The asset representation for GET requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object assetIdEtag
The asset ID and entity tag (ETag) values.
-
object trash
Indicator of whether the asset is in the trash.
-
object assetGet-allOf[3]
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetIdEtag
Type:
object
The asset ID and entity tag (ETag) values.
Show Source
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
Nested Schema : assetGet-allOf[3]
Type:
Show Source
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
Nested Schema : entityLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for an entity's metadata.
Show Source
-
Array of:
object items
Link to the entity's metadata.
Nested Schema : items
Type:
object
Link to the entity's metadata.
Show Source
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.
400 Response
The storage collection specification is missing.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
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:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
409 Response
A storage collection with the same name already exists.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
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:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.