ATatlassian

Get import schedule

Retrieves a specific scheduled import configuration by ID

get/importsource/{importSourceId}/importschedule/{importScheduleId}

Request

  • Base URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1
  • URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1/importsource/{importSourceId}/importschedule/{importScheduleId}
  • Auth
    • OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: import:import-configuration:cmdb
    • or HTTP bearer

Path parameters

importSourceIdstring required

The ID of the import source

importScheduleIdstring required

The ID of the import schedule

Response

Import schedule retrieved successfully

idstring

The unique identifier of the import schedule

importSourceIdstring

The ID of the associated import source

startTimestring date-time

The start time of the schedule in ISO 8601 format

runInterval'ONCE' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

The frequency of the scheduled import

createdstring date-time

Timestamp when the schedule was created

updatedstring date-time

Timestamp when the schedule was last updated

collectionIdstring

The collection (object schema) ID associated with this import

Example response

{
  "id": "a8f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7b",
  "importSourceId": "b9f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7c",
  "startTime": "2024-01-15T02:00:00Z",
  "runInterval": "DAILY",
  "created": "2024-01-10T10:30:00Z",
  "updated": "2024-01-12T14:45:00Z",
  "collectionId": "c7d8e9f0-1234-5678-9abc-def012345678"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.