Jump to

• Request
• Response

createScheduledJob

post

/ccadmin/v1/merchant/scheduledJobs

Create Scheduled Job. Creates scheduled job.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createScheduledJob_request

Type: object

Show Source

• componentPath(optional): string
  Supported scheduled job name
• schedule(optional): object schedule
• scheduleType(optional): string
  Schedule type could be periodic or calendar

{
    "properties":{
        "schedule":{
            "type":"object",
            "properties":{
                "period":{
                    "description":"It contains value in milliseconds.",
                    "type":"integer"
                }
            }
        },
        "scheduleType":{
            "description":"Schedule type could be periodic or calendar",
            "type":"string"
        },
        "componentPath":{
            "description":"Supported scheduled job name",
            "type":"string"
        }
    },
    "example":{
        "schedule":{
            "period":60000
        },
        "scheduleType":"periodic",
        "componentPath":"ScheduledOrderService"
    }
}

Example:

{
    "schedule":{
        "period":60000
    },
    "scheduleType":"periodic",
    "componentPath":"ScheduledOrderService"
}

Nested Schema : schedule

Type: object

Show Source

• period(optional): integer
  It contains value in milliseconds.

{
    "type":"object",
    "properties":{
        "period":{
            "description":"It contains value in milliseconds.",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createScheduledJob_response

Type: object

Show Source

• schedule(optional): object schedule
• scheduleDescription(optional): string
  Descriptive schedule information
• scheduleType(optional): string
  Schedule type could be periodic or calendar

{
    "properties":{
        "schedule":{
            "type":"object",
            "properties":{
                "period":{
                    "description":"It contains value in milliseconds.",
                    "type":"integer"
                }
            }
        },
        "scheduleDescription":{
            "description":"Descriptive schedule information",
            "type":"string"
        },
        "scheduleType":{
            "description":"Schedule type could be periodic or calendar",
            "type":"string"
        }
    }
}

Nested Schema : schedule

Type: object

Show Source

• period(optional): integer
  It contains value in milliseconds.

{
    "type":"object",
    "properties":{
        "period":{
            "description":"It contains value in milliseconds.",
            "type":"integer"
        }
    }
}

Example Response (application/json)

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

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top