request

Get MediaRequest

Changed on

Returns a specific MediaRequest in a JSON object.

get/request/{requestId}

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/request/{requestId}
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

requestIdstring required

Request ID

Response

Succesfully returns request

idnumber required
statusnumber required

Status of the request. 1 = PENDING APPROVAL, 2 = APPROVED, 3 = DECLINED

createdAtstring
updatedAtstring
is4kboolean
serverIdnumber
profileIdnumber
rootFolderstring
ignoreQuotaboolean

If true, this request will not count against the user's quota. Requires MANAGE_REQUESTS permission.

Example response

{
  "id": 123,
  "media": {
    "createdAt": "2020-09-12T10:00:27.000Z",
    "updatedAt": "2020-09-12T10:00:27.000Z"
  },
  "createdAt": "2020-09-12T10:00:27.000Z",
  "updatedAt": "2020-09-12T10:00:27.000Z",
  "requestedBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  },
  "modifiedBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  }
}

Changes