Jump to

• Request
• Response

Retrieve Collections

get

/mobile/tools/1.0/collections

Returns an array of storage collection metadata. You can filter the results, page through the results, and specify a sort order.

Request

Supported Media Types

• application/json

Query Parameters

• exclude(optional): array
  Collection Format: multi

  Expression to exclude from the result the elements that have IDs in the list. Example: exclude=57165555-aa10-4838-938a-354c2b3a287sa&exclude=57165555-aa10-4838-938a-354c2b3a287s

  • [0]: string

  {
      "in":"query",
      "name":"exclude",
      "x-example":"exclude=57165555-aa10-4838-938a-354c2b3a287sa&exclude=57165555-aa10-4838-938a-354c2b3a287s",
      "description":"Expression to exclude from the result the elements that have IDs in the list.\n\nExample: <code>exclude=57165555-aa10-4838-938a-354c2b3a287sa&exclude=57165555-aa10-4838-938a-354c2b3a287s</code>",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• filterType(optional): string
  Allowed Values: [NOT_PUBLISHED, PUBLISHED, NOT_TRASH, TRASH, MAX_EXCLUDE, MAX_INCLUDE, MAX_ONLY].

  Filter collections by the following filter types. You can provide multiple values as a comma-separated string. For example, filterType=NOT_PUBLISHED,NOT_TRASH,MAX_ONLY.

  • PUBLISHED returns all collections that are in the published state.
  • NOT_PUBLISHED returns all collections that aren't in the published state.
  • TRASH returns all collections that have the inTrash attribute set to true.
  • NOT_TRASH returns all collections that have the inTrash attribute set to false.
  • MAX_INCLUDE returns all collections including those that have the max attribute set to true.
  • MAX_EXCLUDE (the default) returns all collections except those that have the max attribute set to true.
  • MAX_ONLY returns only the collections that have the max attribute set to true.

• fromTime(optional): string

  Include only the assets that have been modified or deleted on or after the specified time. Example: 2016-03-03T15:13:39.419Z.

  Filters by modifiedOn for assets that haven't been trashed and by deletedOn for trashed assests.

  Supported values:

  • Number of milliseconds since January 1, 1970, 00:00:00 GMT
  • Date in ISO 8601 format
  • Relative value, such as -1s, -1m, and -1h
• id(optional): array
  Collection Format: multi

  Expression to return only the elements that have IDs in the list. Example: id=93079180-bb00-4838-938a-753c2b3a957a&id=57165555-aa10-4838-938a-354c2b3a287s

  • [0]: string

  {
      "in":"query",
      "name":"id",
      "x-example":"id=93079180-bb00-4838-938a-753c2b3a957a&id=57165555-aa10-4838-938a-354c2b3a287s",
      "description":"Expression to return only the elements that have IDs in the list.\n\nExample: <code>id=93079180-bb00-4838-938a-753c2b3a957a&id=57165555-aa10-4838-938a-354c2b3a287s</code>",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• limit(optional): integer(int64)
  The maximum number of items to return. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
• offset(optional): integer(int64)
  The index where you want to start browsing the list of items. If you don't specify an offset, then the offset defaults to 0, which is the first item in the list. The response contains the offset used and a link to get the previous set of items.
• orderBy(optional): string
  The sort order for the results. The default sort order is ascending by name. When you specify a sort order with pagination, the next and previous links respect the ordering. Multiple values can be provided as a comma-separated string. Format: `orderBy=attr[:("asc"|"desc")] [,attr[:("asc"|"desc")]]`, where the `attr` parameter can be one of [ name | version | modifiedOn | createdOn | deletedOn | deletedBy ]. Example: `orderBy=name:asc,modifiedOn:desc`

  Default Value: name:asc
• q(optional): string
  Performs a case-insensitive search for collections that have a name, display name, or description that contains the string that's provided in this parameter. For example, q=myCollection. This parameter doesn't support query languages.
• toTime(optional): string

  Include only the assets that have been modified or deleted on or before the specified time. Example: 2016-03-03T15:13:39.419Z.

  Filters by modifiedOn for assets that haven't been trashed and by deletedOn for trashed assests.

  Supported values:

  • Number of milliseconds since January 1, 1970, 00:00:00 GMT
  • Date in ISO 8601 format
  • Relative value, such as -1s, -1m, and -1h
• totalResults(optional): boolean
  Reserved for enabling the total number of available elements in the response. This parameter is ignored because the total elements count always is available and is provided in the response.

Header Parameters

• Accept-Language(optional): string
  Indicates the preferred set of natural languages to use for the response. The results are sorted based on the language. Example: da, en-gb;q=0.8, en;q=0.7.

Back to Top

Response

Supported Media Types

• application/json

200 Response

An array of metadata for storage collections with pagination information.

Body ()

An array of storage collection elements with paging information.

Root Schema : mosCollectionPaging

Type: object

An array of storage collection elements with paging information.

Match All

Show Source

• object paging
  The pagination information.
• object mosCollectionPaging-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/paging"
        },
        {
            "properties":{
                "items":{
                    "$ref":"#/definitions/mosCollectionArray"
                }
            }
        }
    ],
    "description":"An array of storage collection elements with paging information.",
    "type":"object",
    "required":[
        "hasMore",
        "count"
    ]
}

Nested Schema : paging

Type: object

The pagination information.

Show Source

• count: integer(int64)
  The number of elements in this response.
• hasMore: boolean
  Indicates whether the collection has more elements to be retrieved.
• limit(optional): integer(int64)
  The maximum number of items returned. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
• links(optional): array paginationLinksArray
  Minimum Number of Items: 0

  An array of links for paginated metadata.
• totalResults(optional): integer(int64)
  The total number of elements on the server side that satisfy the request. This attribute is returned only when the request includes the `totalResults` query parameter with a value of `true`.

{
    "description":"The pagination information.",
    "type":"object",
    "properties":{
        "totalResults":{
            "format":"int64",
            "description":"The total number of elements on the server side that satisfy the request. This attribute is returned only when the request includes the `totalResults` query parameter with a value of `true`.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether the collection has more elements to be retrieved.",
            "type":"boolean"
        },
        "count":{
            "format":"int64",
            "description":"The number of elements in this response.",
            "type":"integer"
        },
        "limit":{
            "format":"int64",
            "description":"The maximum number of items returned. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.",
            "type":"integer"
        },
        "links":{
            "$ref":"#/definitions/paginationLinksArray"
        }
    },
    "required":[
        "hasMore",
        "count"
    ]
}

Nested Schema : mosCollectionPaging-allOf[1]

Type: object

Show Source

• items(optional): array mosCollectionArray
  Minimum Number of Items: 0

  An array of the storage collections' metadata.

{
    "properties":{
        "items":{
            "$ref":"#/definitions/mosCollectionArray"
        }
    }
}

Nested Schema : paginationLinksArray

Type: array

Minimum Number of Items: 0

An array of links for paginated metadata.

Show Source

• Array of: object Link to the paginated metadata.
  Title: Link to the paginated metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for paginated metadata.",
    "type":"array",
    "items":{
        "type":"object",
        "title":"Link to the paginated metadata.",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical",
                    "next",
                    "prev",
                    "first",
                    "last"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : Link to the paginated metadata.

Type: object

Title: Link to the paginated metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical", "next", "prev", "first", "last" ]

  Link type.

{
    "type":"object",
    "title":"Link to the paginated metadata.",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical",
                "next",
                "prev",
                "first",
                "last"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Nested Schema : mosCollectionArray

Type: array

Minimum Number of Items: 0

An array of the storage collections' metadata.

Show Source

• Array of: object mosCollectionGet
  The storage collection representation for GET requests.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of the storage collections' metadata.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/mosCollectionGet"
    }
}

Nested 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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "userIsolated":{
                    "type":"boolean"
                },
                "guid":{
                    "type":"string"
                },
                "syncControl":{
                    "type":"boolean"
                }
            }
        }
    ],
    "description":"The storage collection representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "userIsolated",
        "guid",
        "links",
        "id",
        "published",
        "syncControl",
        "version"
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "$ref":"#/definitions/assetIdEtag"
        },
        {
            "$ref":"#/definitions/trash"
        },
        {
            "properties":{
                "modifiedOn":{
                    "type":"string"
                },
                "deletedOn":{
                    "type":"string"
                },
                "modifiedBy":{
                    "type":"string"
                },
                "links":{
                    "$ref":"#/definitions/entityLinksArray"
                },
                "published":{
                    "description":"An asset draft or published status representation.",
                    "type":"boolean"
                },
                "createdOn":{
                    "type":"string"
                },
                "deletedBy":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The asset representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : mosCollectionGet-allOf[1]

Type: object

Show Source

• guid(optional): string
• syncControl(optional): boolean
• userIsolated(optional): boolean

{
    "properties":{
        "userIsolated":{
            "type":"boolean"
        },
        "guid":{
            "type":"string"
        },
        "syncControl":{
            "type":"boolean"
        }
    }
}

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.

{
    "description":"The asset representation for PUT requests.",
    "type":"object",
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        },
        "namespace":{
            "description":"Applicable to APIs and implementations only. This value is null for all other asset types.",
            "type":"string"
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "maxLength":100
        },
        "title":{
            "type":"string",
            "maxLength":255
        },
        "version":{
            "$ref":"#/definitions/version"
        },
        "actionComment":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "maxLength":100
        }
    },
    "required":[
        "name"
    ]
}

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

{
    "description":"The asset ID and entity tag (ETag) values.",
    "type":"object",
    "properties":{
        "etag":{
            "description":"The asset entity tag (ETag) value, which you can use to detect concurrent modification.",
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Show Source

• inTrash(optional): boolean

{
    "description":"Indicator of whether the asset is in the trash.",
    "type":"object",
    "properties":{
        "inTrash":{
            "type":"boolean"
        }
    }
}

Nested Schema : assetGet-allOf[3]

Type: object

Show Source

• 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.

{
    "properties":{
        "modifiedOn":{
            "type":"string"
        },
        "deletedOn":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/entityLinksArray"
        },
        "published":{
            "description":"An asset draft or published status representation.",
            "type":"boolean"
        },
        "createdOn":{
            "type":"string"
        },
        "deletedBy":{
            "type":"string"
        }
    }
}

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.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for an entity's metadata.",
    "type":"array",
    "items":{
        "description":"Link to the entity's metadata.",
        "type":"object",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : items

Type: object

Link to the entity's metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical" ]

  Link type.

{
    "description":"Link to the entity's metadata.",
    "type":"object",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top