Forget one Artifact without changing its content revision

POST
/v1/scopes/{scope_id}/artifacts/{family}/{artifact_id}/forget

Deprecates the exact current Artifact without a replacement so it leaves search; restoration brings it back. Available for every Family registered with the shared merge service.

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer credential resolved to an opaque authenticated Principal by the Server deployment.

In: header

Path Parameters

scope_id*string
Match.*\S.*
Length1 <= length <= 256
family*string
Match^[a-z][a-z0-9-]*$
Length1 <= length <= 128
artifact_id*string
Match^[\x21-\x7E]+$
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/scopes/string/artifacts/string/string/forget" \  -H "Content-Type: application/json" \  -d '{    "revision": 1,    "state_version": 0  }'
{  "changed": true,  "records": [    {      "artifact": {        "family": "string",        "artifact_id": "string",        "revision": 1      },      "lifecycle_state": "active",      "state_version": 0,      "merged_into_id": "string"    }  ]}