Global

Returns information of the scheduler job

get/sites/{site-identifier}/jobs/{guid}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/jobs/{guid}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

guidstring required

The GUID that identifies a SchedulerJob

Response

Success

Status'RUNNING' | 'QUEUED' | 'CANCELLED' | 'COMPLETE'
JobStartDateTimestring date-time
JobEndDateTimestring date-time
JobScheduledDateTimestring date-time
JobNamestring
JobType'PROCESS' | 'INTERFACE' | 'REPORT' | 'DOCUMENT' | 'REPORT-SUITE'
EntityType'BANK' | 'FUND' | 'LIST' | 'MEMBER' | 'SYSTEM'
EntityCodestring
EntityNamestring
Messagesstring[]
AttachmentCountinteger
MessageCountinteger
DocumentRequestGUIDstring guid
DocumentRequestStatusCode'SIGNED' | 'OUT_FOR_SIGNATURE' | 'CANCELLED' | 'DECLINED' | 'ERROR' | 'DECLINE_ACKNOWLEDGED'

Example response

{
  "JobStartDateTime": "2020-03-24T15:55:52.679+07:00",
  "JobEndDateTime": "2020-03-24T15:56:52.679+07:00",
  "JobScheduledDateTime": "2020-03-24T15:55:52.679+07:00",
  "EntityCode": "ADF_0802 - ADF_0802",
  "EntityName": "ADF_0802",
  "Messages": [
    "message text"
  ],
  "Output": [
    {
      "EntityType": "FUND",
      "EntityCode": "ADF_0802 - ADF_0802",
      "EntityName": "ADF_0802",
      "FileName": "filename.pdf",
      "FileSizeBytes": 123,
      "FileSize": "123 Bytes",
      "FileURL": "http://localhost/api/v1/sites/LOCAL/jobs/a893d49b-873d-1bb5-6614-f40df09e5243/output/a893d49b-873d-1bb5-6614-fb0ddc9f3e95",
      "JobOutputGUID": "ba01537e-7cbc-e9bb-4114-1d17e8ac3c69"
    }
  ],
  "DocumentRequestGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111"
}

Changes

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