Global

<b>BETA:</b> Returns the list of scheduler jobs for the user

get/sites/{site-identifier}/jobs

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/jobs
  • 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

Query parameters

fundidentifierstring

The Fund identifier.

type'PROCESS' | 'INTERFACE' | 'REPORT' | 'DOCUMENT'

The Job type.

typeCodestring
Example:ReportSuiteLauncher

The Job type code.

statusstring
Example:QUEUED,RUNNING,COMPLETE,CANCELLED,IMMEDIATE

A comma-separated list of job status

start-datestring date
Example:2024-08-10

The valuation date with format (yyyy-MM-dd).

end-datestring date
Example:2024-09-10

The valuation date with format (yyyy-MM-dd).

jobGuidsstring

A comma-separated list of scheduler job GUID

Response

Success

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

Example response

[
  {
    "JobGUID": "ba01537e-7cbc-e9bb-4114-1d17e8ac3c69",
    "JobScheduledDateTime": "2020-03-24T15:55:52.679+07:00",
    "JobStartDateTime": "2020-03-24T15:55:52.679+07:00",
    "JobEndDateTime": "2020-03-24T15:56:52.679+07:00",
    "EntityCode": "ADF_0802 - ADF_0802",
    "EntityName": "ADF_0802",
    "FundGUID": "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.