InventoryObjects

Archive a inventory_object

post/v3/administrations/{administration_id}/inventory_objects/{id}/archive

Request

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[inventory_object]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "inventory_object",
    "relationships": {
      "current_or_future_external_blocked_agenda_periods": {
        "data": [
          {
            "type": "external_blocked_agenda_period"
          }
        ]
      },
      "labels": {
        "data": [
          {
            "type": "label"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "external_blocked_agenda_period",
      "relationships": {
        "rentable": {
          "data": {
            "type": "rentable"
          }
        }
      }
    }
  ]
}

Response

InventoryObjectResponse

Example response

{
  "data": {
    "id": "1",
    "type": "inventory_object",
    "relationships": {
      "current_or_future_external_blocked_agenda_periods": {
        "data": [
          {
            "type": "external_blocked_agenda_period"
          }
        ]
      },
      "labels": {
        "data": [
          {
            "type": "label"
          }
        ]
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "cluster_children": {
        "data": [
          {
            "type": "inventory_object"
          }
        ]
      },
      "images": {
        "data": [
          {
            "type": "image"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "external_blocked_agenda_period",
      "relationships": {
        "rentable": {
          "data": {
            "type": "rentable"
          }
        }
      }
    }
  ]
}

Changes

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status