API

Prepare an encrypted metadata patch for a saved ordinary group

Generated from the checked-in source. Do not edit this reference by hand.

POST /api/v1/vendors/{id}/asset-management/group-updates

Platform administrator only. Requires a successful saved group and current distinct UpdateAssetGroup qualification. Derives the original upstream identity from storage. Saves immutable update identity and digest with an encrypted 24-hour patch. Same update identity and patch is idempotent; changed patch conflicts. Does not dispatch, claim completion, release a hold or charge inference. Explicit empty description is retained; omit a field to leave it unchanged.

Operation: post--api-v1-vendors--id--asset-management-group-updates.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "adminBearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X POST "$NIU_ORIGIN/api/v1/vendors/{id}/asset-management/group-updates" \
  -H "Authorization: Bearer $NIU_ADMIN_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @request.json

Parameters

id

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

Request body

application/json

Required.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "organization_id",
    "project_id",
    "intent_id",
    "update_id"
  ],
  "properties": {
    "organization_id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "intent_id": {
      "type": "string",
      "format": "uuid"
    },
    "update_id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "description": {
      "type": "string",
      "maxLength": 300
    }
  },
  "anyOf": [
    {
      "required": [
        "name"
      ]
    },
    {
      "required": [
        "description"
      ]
    }
  ]
}

Responses

HTTP 200

Identical preparation already exists; no overwrite or upstream dispatch.

HTTP 201

Encrypted patch prepared; data contains update_id, prepared true and dispatch_available.

HTTP 400

Invalid metadata or empty patch.

HTTP 401

Authentication required.

HTTP 403

Platform administrator required.

HTTP 404

Saved original group is unavailable in this scope.

HTTP 409

Qualification unavailable or changed patch conflicts.

HTTP 422

Malformed request.

HTTP 503

Encryption unavailable.