Retrieve details of an existing request

Select

SaaS

Customer Managed

Retrieve details of an existing request

Path Parameters

• requestId int32 required

  Possible values: >= 1

  Unique identifier for the request

Responses

• 200
• 400
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id int32

  Request id

• name string

  Request name

• type RMRequestType

  Possible values: [EXPORT, DELETE, MOVE, RETENTION, IGNORE, ARCHIVE, TAG]

• status RMRequestStatus

  Possible values: [TaskCreated, TaskConfigured, ReviewInProgress, ReviewCompleted, ApproveCompleted, TaskCompleted, ApprovalRequested, ActionInProgress, CompletedWithErrors, Failed, ReviewDeclined]

  Signifies the progress of the request

• requestor email

  Email of the requestor

• application ActivateApplication

  Possible values: [NONE, SDG, FSO]

  Enum to signify the application under Activate

• createdOn int64

  Request creation time in unix epoch format

• owner object

  id int32

  name string
• reviewers object[]

  List of request reviewers

  id int32

  name string
• approvers object[]

  List of the request approvers

  id int32

  name string
• properties object[]

  Properties of the request

  name string

  value string

  values string[]

{
  "id": 0,
  "name": "string",
  "type": "EXPORT",
  "status": "TaskCreated",
  "requestor": "user@example.com",
  "application": "NONE",
  "createdOn": 0,
  "owner": {
    "id": 0,
    "name": "string"
  },
  "reviewers": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "approvers": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "properties": [
    {
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Loading...