List Drafts

GET 
/configuration-hub/drafts

This API gets a list of existing drafts for the current tenant.

Request

Query Parameters

filters string
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
status: eq
approvalStatus: eq
Example: status eq "COMPLETE"

Responses

200

List of existing drafts.

application/json

Schema

Schema

• Array [

jobId string

Unique id assigned to this job.

status string

Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

Status of the job.

type string

Possible values: [CREATE_DRAFT]

Type of the job, will always be CREATE_DRAFT for this type of job.

message string

Message providing information about the outcome of the draft process.

requesterName string

The name of user that that initiated the draft process.

fileExists boolean

Default value: true

Whether or not a file was generated for this draft.

created date-time

The time the job was started.

modified date-time

The time of the last update to the job.

completed date-time

The time the job was completed.

name string

Name of the draft.

sourceTenant string

Tenant owner of the backup from which the draft was generated.

sourceBackupId string

Id of the backup from which the draft was generated.

sourceBackupName string

Name of the backup from which the draft was generated.

mode string
Possible values: [RESTORE, PROMOTE, UPLOAD]
Denotes the origin of the source backup from which the draft was generated.
• RESTORE - Same tenant.
• PROMOTE - Different tenant.
• UPLOAD - Uploaded configuration.
approvalStatus string

Possible values: [DEFAULT, PENDING_APPROVAL, APPROVED, DENIED]

Approval status of the draft used to determine whether or not the draft can be deployed.

approvalComment

object[]

List of comments that have been exchanged between an approval requester and an approver.

Array [

comment stringrequired

Comment provided either by the approval requester or the approver.

timestamp date-timerequired

The time when this comment was provided.

user stringrequired

Name of the user that provided this comment.

id stringrequired

Id of the user that provided this comment.

changedToStatus stringrequired

Possible values: [PENDING_APPROVAL, APPROVED, REJECTED]

Status transition of the draft.

]

• ]

Example (from schema)

[
  {
    "jobId": "07659d7d-2cce-47c0-9e49-185787ee565a",
    "status": "COMPLETE",
    "type": "CREATE_DRAFT",
    "message": "Draft creation message",
    "requesterName": "requester.name",
    "fileExists": true,
    "created": "2021-05-11T22:23:16Z",
    "modified": "2021-05-11T22:23:16Z",
    "completed": "2021-05-11T22:23:16Z",
    "name": "Draft name",
    "sourceTenant": "source-tenant",
    "sourceBackupId": "549bf881-1ac4-4a64-9acf-6014e8a3a887",
    "sourceBackupName": "Source backup name",
    "mode": "RESTORE",
    "approvalStatus": "APPROVED",
    "approvalComment": [
      {
        "comment": "Approval comment",
        "timestamp": "2021-05-11T22:23:16Z",
        "user": "user.name",
        "id": "549bf881-1ac4-4a64-9acf-6014e8a3a887",
        "changedToStatus": "PENDING_APPROVAL"
      }
    ]
  }
]

Example

[
  {
    "jobId": "07659d7d-2cce-47c0-9e49-185787ee565a",
    "status": "COMPLETE",
    "type": "CREATE_DRAFT",
    "message": "Draft creation message",
    "requesterName": "Requester Name",
    "fileExists": true,
    "created": "2024-08-16T14:16:58.389Z",
    "completed": "2024-08-16T14:17:12.355Z",
    "name": "Draft Name",
    "sourceTenant": "source-tenant",
    "sourceBackupId": "9393e1f5-bed6-4fa8-80fb-6f86b19bd3d6",
    "sourceBackupName": "Source Backup Name",
    "mode": "RESTORE",
    "approvalStatus": "DEFAULT",
    "approvalComment": [
      {
        "comment": "Approval comment",
        "timestamp": "2024-08-26T19:32:46.384137Z",
        "user": "User name",
        "id": "User id",
        "changedToStatus": "PENDING_FOR_APPROVAL"
      }
    ]
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...