getScheduledJob

get

/ccadmin/v1/merchant/scheduledJobs

Get Scheduled Job. Gets the scheduled job setting.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Query Parameters

id

Type: string

Required: true

Job id of schedule

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getScheduledJob_response

Properties

schedule

Type: object schedule

Additional Properties Allowed:

scheduleDescription

Type: string

Descriptive schedule information

scheduleType

Type: string

Schedule type could be periodic or calendar

Nested Schema : schedule

Type: object

Properties

period

Type: integer

It contains value in milliseconds.

Example application/json

{
    "schedule":{
        "period":60000
    },
    "scheduleDescription":"every 100 minutes without catch up",
    "scheduleType":"periodic"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

errors

Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

type

Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "schedule": {"period": 60000},
  "scheduleDescription": "every 100 minutes without catch up",
  "scheduleType": "periodic"
}