On-Call Policy Schedule

Get On-Call Policy Schedule

Endpoint to retrieve a single On-Call Policy Schedule by ID

post/on-call-duty-policy-schedule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the On-Call Policy Schedule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "timezone": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Weekend On-Call Rotation",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "description": "This schedule handles on-call duties during weekend hours for production incidents",
    "timezone": "America/New_York",
    "slug": "example-slug-value",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "currentUserIdOnRoster": "123e4567-e89b-12d3-a456-426614174000",
    "nextUserIdOnRoster": "123e4567-e89b-12d3-a456-426614174000",
    "rosterHandoffAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "rosterNextHandoffAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "rosterNextStartAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "rosterStartAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "shiftConfigVersion": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.