taskSchedules

Returns a task schedule by id.

Changed on

Returns a task schedule by id. The response includes the schedule's task and timing settings. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/taskschedules/{taskScheduleId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/taskschedules/{taskScheduleId}
  • Auth: HTTP bearer

Path parameters

taskScheduleIdstring uuid required

The id of the task schedule.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

userIdstring uuid

The id of the user this task schedule is for.

taskIdstring uuid

The id of the task this task schedule is for.

startDatestring date-time

The start date and time of this task schedule.

endDatestring date-time

The end date and time of this task schedule.

plannedDurationinteger

The number of seconds of planned work.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetTaskScheduleById removed and replaced with taskSchedules_GetTaskScheduleById