autopilot

Returns the autopilot with the specified id.

Changed on

Returns the autopilot including its alerts. To get the autopilot data the user needs to be the owner of the project or 'read' permissions of the feature 'project-master-data' globally or in their project role.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/autopilot/{autopilotId}

Request

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

Path parameters

autopilotIdstring uuid required

The id of the autopilot.

Response

OK

typestring required

The type of the autopilot.

enabledboolean required

Whether the autopilot is enabled.

idstring uuid

The id of the autopilot.

createdOnstring date-time

The date this object was created.

createdBystring uuid

The id of the user who created this object.

updatedOnstring date-time

The date this object was last modified.

updatedBystring uuid

The id of the user who last modified this object.

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 GetAutopilotByAutopilotId removed and replaced with autopilot_GetAutopilotByAutopilotId