Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Approval (Deprecated)

Submit approval request

post/v1/workspaces/{workspaceId}/approval-requests

Path parameters

workspaceIdstring required

Represents workspace identifier across the system.

Example:dd087fe2dd087fe2dd087fe2

Represents workspace identifier across the system.

Request body

period'WEEKLY' | 'SEMI_MONTHLY' | 'MONTHLY'

Specifies the approval period. It has to match the workspace approval period setting.

periodStartstring required

Specifies an approval period start date in yyyy-MM-ddThh:mm:ssZ format.

typestring

Example request

{
  "period": "MONTHLY",
  "periodStart": "2020-01-01T00:00:00.000Z"
}

Response

Created

idstring

Represents approval request identifier across the workspace.

typestring

Represents approval request type.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "creator": {
    "userEmail": "johhndoe@example.com",
    "userId": "5a0ab5acb07987125438b60f",
    "userName": "johhndoe"
  },
  "id": "567687e29ae1f428e7ebf564",
  "owner": {
    "startOfWeek": "MONDAY",
    "timeZone": "Europe/Budapest",
    "userId": "5a0ab5acb07987125438b60f",
    "userName": "johndoe"
  },
  "status": {
    "note": "This is a sample approval request note.",
    "state": "APPROVED",
    "updatedAt": "2020-01-01T08:00:00Z",
    "updatedBy": "5a0ab5acb07987125438b60f",
    "updatedByUserName": "juandelacruz"
  },
  "workspaceId": "64a687e29ae1f428e7ebe303"
}