Jump to

• Request
• Response

Performs Bulk Items Asset Refresh Operation

post

/content/management/api/v1.1/items/.bulk/assetRefresh

Performs Bulk Items Asset Refresh with given payload.

Request

Supported Media Types

• application/json

Header Parameters

• Prefer(optional): string
  This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.

  Allowed Values: [ "respond-async" ]
• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Details of the bulk items operations.

Root Schema : BulkItemsValidateAssetRefresh

Type: object

Item Bulk Validate Asset Refresh

Show Source

• failedItems(optional): array failedItems
  items on which the asset refresh validation failed
• items(optional): array items
  Asset refresh items list
• links(optional): array links
  Links of the bulk items operations resource.
• q(optional): string
  This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of id eq "{itemId}". Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported.

  Example: id eq "COREBE1BDF66159849B790CC9ACE49BD2199" OR id eq "CONT22AA154CDD884D81A3678E1BD37333B7"

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "example":"id eq \"COREBE1BDF66159849B790CC9ACE49BD2199\" OR id eq \"CONT22AA154CDD884D81A3678E1BD37333B7\"",
            "description":"This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of <b><i>id eq \"{itemId}\"</i></b>. Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported."
        },
        "items":{
            "type":"array",
            "description":"Asset refresh items list",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the asset refresh validation failed",
            "items":{
                "$ref":"#/definitions/AssetRefreshFailedItemId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the bulk items operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item Bulk Validate Asset Refresh"
}

Nested Schema : failedItems

Type: array

items on which the asset refresh validation failed

Show Source

• Array of: object AssetRefreshFailedItemId

{
    "type":"array",
    "description":"items on which the asset refresh validation failed",
    "items":{
        "$ref":"#/definitions/AssetRefreshFailedItemId"
    }
}

Nested Schema : items

Type: array

Asset refresh items list

Show Source

• Array of: object ItemId

{
    "type":"array",
    "description":"Asset refresh items list",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

Nested Schema : links

Type: array

Links of the bulk items operations resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the bulk items operations resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : AssetRefreshFailedItemId

Type: object

Show Source

• id(optional): string
  id of the item.
• message(optional): string
  failed item message.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "message":{
            "type":"string",
            "description":"failed item message."
        }
    }
}

Nested Schema : ItemId

Type: object

Show Source

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

links of the item resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the item resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top