jobDetails

jobDetails

GET

/{businessLine}/details/{scheduledTaskId}

Returns details associated with the schedule, including the schedule name, last run date, next run date and additional information for a specific scheduled task Id.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting.

string

scheduledTaskId

The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting. true

scheduledTaskId The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call. true

HTTP Basic

OAuth 2.0

API Key

Working...

jobDetails

jobDetails

GET

/{businessLine}/details/{scheduledTaskId}

Returns details associated with the schedule, including the schedule name, last run date, next run date and additional information for a specific scheduled task Id.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting.

string

scheduledTaskId

The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting. true

scheduledTaskId The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call. true

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
TLS*: https://mtls.api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

jobDetails

jobDetails

GET

/{businessLine}/details/{scheduledTaskId}

Returns details associated with the schedule, including the schedule name, last run date, next run date and additional information for a specific scheduled task Id.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting.

string

scheduledTaskId

The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting. true

scheduledTaskId The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call. true

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
  https://api.seic.com/v1/jobs/endClientReporting/status/NTcxg6MDMgUE0= \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN'


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
  "data": {
    "scheduledTaskId": 999,
    "scheduledTaskName": "string",
    "messageText": "Successfully queued ecr request.",
    "scheduledTaskFrequencyId": 7,
    "requestParameters": null,
    "activeFlag": true,
    "insertedBy": "string",
    "insertDate": "2018-01-01T00:00:00",
    "updatedBy": null,
    "updateDate": "2018-03-31T00:00:00",
    "nextRunDate": "2018-04-01T16:00:00",
    "lastRunDate": "2018-03-01T14:36:40.6260581",
    "lastScheduledRunDate": "2018-03-01T14:36:10.8034748",
    "lastCompletionDate": "2018-03-01T14:36:40.6400619",
    "timeZoneSystemId": "Eastern Standard Time",
    "startDate": "2018-01-01T16:00:00",
    "endDate": "2018-12-31T17:00:00",
    "cancelFlag": false,
    "cancelledBy": null,
    "monthDay": null,
    "weekDays": null,
    "businessCalendarId": null,
    "businessDay": null,
    "requestDescTypeId": 7,
  }
}


MODEL
Operations
Name Description Data Type (L)
scheduledTaskId

The identifier required to request a pre-configured report be run.

string
scheduledTaskName

The name that represents the schedule associated with a pre-configured report. This name can be different from the actual report name.

messageText

Confirmation that the job for the schedule has been queued to be triggered.

string
requestParameters

Pre configured report parameters are preset. 

string
clientId

Identifies the SEI id for the firm the schedule was created for.

string
activeFlag

Identifies if the schedule is still active. If active, value will be 'true', if inactive, value will be 'false'. An inactive schedule will no longer be run at any frequency.

string
insertedBy

The id of the person who created the schedule.

string
insertDate

The date time the schedule was initially created.

string
updatedBy

The id of the person who last modified the schedule.

string
updateDate

The date time the schedule was last modified.

string
nextRunDate

The next scheduled run date. If the run date is in the past, the schedule is expired and will no longer run.

string
lastRunDate

The last date time the schedule was run, either through the schedule or ad hoc. This can be a scheduled or ad hoc run.

string
lastScheduledRunDate

The actual date and time when the schedule actually ran.

string
lastCompletionDate

The last time the schedule was run successfully

string
timeZoneSystemId

The time zone associated with the schedule and any date times in a response.

string
startDate

A schedule is created to automate the run of a report over time. The start date is the initial date for when the schedule started.

string
endDate

A schedule is created to automate the run of a report over time. The end date is the last date for when the schedule will run.

string
cancelFlag

Identifies if the schedule was canceled. Value options are 'true' or 'false'.

string
cancelledBy

Identifies the database id of the user who canceled the schedule.

string
monthDay

The day of the month for which the schedule is set up for a run. This option appears if user selects the Period as Monthly under the ‘Frequency’ tab. 1 is the first day of the month, 2 the second day, etc.

string
weekDays

The day(s) of the week for which the schedule has been set up to run. These are supposed to be the days checked under the ‘Weekly’ option.

string
businessCalendarId

The id of the calendar that is being used to determine the business days if the ‘Business Days Only’ check-box has been checked. Values are ‘NYSE’ or ‘London Stock Exchange’.

string
businessDay

Indicates if the schedule should be run on business days only as defined by the businessCalendar selected. Value options are ‘true’ or ‘false’.

string
requestDescTypeId string
scheduledTaskFrequencyId

Frequency of the schedule. Values can be ‘one time’, ‘daily’, ‘weekly’, ‘monthly’ or ‘adhoc’.

string


jobDetails

jobDetails

GET

/{businessLine}/details/{scheduledTaskId}

Returns details associated with the schedule, including the schedule name, last run date, next run date and additional information for a specific scheduled task Id.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/details/{scheduledTaskId}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting.

string

scheduledTaskId

The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting. true

scheduledTaskId The identifier required to request a pre-configured report be run. The list of entitled ids can be obtained from the jobMetadata API call. true

HTTP Basic

OAuth 2.0

API Key

Working...