Update Publication Status

PATCH

/datasets/{dataset_id}/status/

curl --request PATCH \
  --url https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "example" }'

Transition a dataset’s publication status following allowed paths.

Allowed transitions: draft -> ready -> internal -> published (and back one step).

Authorizations

• OAuth2PasswordBearer

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Request Body ^required

Media type application/json

StatusUpdate

object

status

required

Status

string

<= 20 characters

Example ^generated

{
  "status": "example"
}

Responses

200

Successful Response

Media type application/json

StatusUpdateResponse

object

id

required

Id

string

record_status

required

Record Status

string

Example ^generated

{
  "id": "example",
  "record_status": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}