Jump to

• Request
• Response

Execute Task

post

/v1/tasksByName/{taskName}/jobs

Request

Supported Media Types

• application/json

Path Parameters

• taskName: string
  Name of Task

Body ()

Parameters for Task generation or execution

Root Schema : TaskExecuteRequest

Type: object

Show Source

• operationName(optional): string
• taskConfigId(optional): string

{
    "type":"object",
    "properties":{
        "taskConfigId":{
            "type":"string"
        },
        "operationName":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : Job

Type: object

Show Source

• actionRefs(optional): array actionRefs
• actions(optional): array actions
• businessName(optional): string
  The job business name.
• createdBy(optional): string
  The user that created the job
• description(optional): string
  The job description.
• errorMessage(optional): string
  The error message for the job
• jobDefinitionRef(optional): object ReferenceJobDefinition
• jobEndTime(optional): object ZonedDateTime
• jobProperties(optional): object jobProperties
  Additional Properties Allowed: additionalProperties

  The properties used to bind with actions
• jobStartTime(optional): object ZonedDateTime
• jobType(optional): string
  The JobType for the job
• lastUpdated(optional): object ZonedDateTime
• name(optional): string
  The job name.
• objectStatus(optional): integer(int32)
  Read Only: true
• status(optional): string
  Allowed Values: [ "BP", "FL", "PR", "PS", "RN", "SU", "TRQ", "BT", "TR", "WT", "PO", "BS", "ST", "SRQ", "BR", "RSQ", "WRN" ]

  The current status of the job
• taskConfigRef(optional): object ReferenceTaskConfig

{
    "type":"object",
    "properties":{
        "objectStatus":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "actionRefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Reference"
            }
        },
        "jobProperties":{
            "type":"object",
            "description":"The properties used to bind with actions",
            "additionalProperties":{
                "type":"string"
            }
        },
        "name":{
            "type":"string",
            "description":"The job name."
        },
        "businessName":{
            "type":"string",
            "description":"The job business name."
        },
        "description":{
            "type":"string",
            "description":"The job description."
        },
        "jobType":{
            "type":"string",
            "description":"The JobType for the job"
        },
        "createdBy":{
            "type":"string",
            "description":"The user that created the job"
        },
        "errorMessage":{
            "type":"string",
            "description":"The error message for the job"
        },
        "jobStartTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "jobEndTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "lastUpdated":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "jobDefinitionRef":{
            "$ref":"#/definitions/ReferenceJobDefinition"
        },
        "status":{
            "type":"string",
            "description":"The current status of the job",
            "enum":[
                "BP",
                "FL",
                "PR",
                "PS",
                "RN",
                "SU",
                "TRQ",
                "BT",
                "TR",
                "WT",
                "PO",
                "BS",
                "ST",
                "SRQ",
                "BR",
                "RSQ",
                "WRN"
            ]
        },
        "taskConfigRef":{
            "$ref":"#/definitions/ReferenceTaskConfig"
        }
    }
}

Nested Schema : actionRefs

Type: array

Show Source

• Array of: object Reference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Reference"
    }
}

Nested Schema : actions

Type: array

Show Source

• Array of: object Action
  A DIPC Job Action

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Action"
    }
}

Nested Schema : ReferenceJobDefinition

Type: object

Show Source

• isDependency(optional): boolean
  Default Value: false

  Example: false
• namePath(optional): string
  Example: null
• namespace(optional): object Number
• referenceName(optional): string
  Example: connectionTypeRef
• refObjectType(optional): string
  The full name of the design model class for the referenced object

  Example: null
• uoid(optional): string
  Example: null
• uoidPath(optional): string
  Example: null

{
    "type":"object",
    "properties":{
        "uoidPath":{
            "type":"string",
            "example":"null"
        },
        "namePath":{
            "type":"string",
            "example":"null"
        },
        "refObjectType":{
            "type":"string",
            "example":"null",
            "description":"The full name of the design model class for the referenced object"
        },
        "isDependency":{
            "type":"boolean",
            "example":"false",
            "default":false
        },
        "namespace":{
            "$ref":"#/definitions/Number"
        },
        "referenceName":{
            "type":"string",
            "example":"connectionTypeRef"
        },
        "uoid":{
            "type":"string",
            "example":"null"
        }
    }
}

Nested Schema : ZonedDateTime

Type: object

Show Source

• chronology(optional): object Chronology
• dayOfMonth(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• dayOfYear(optional): integer(int32)
• hour(optional): integer(int32)
• minute(optional): integer(int32)
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• monthValue(optional): integer(int32)
• nano(optional): integer(int32)
• offset(optional): object ZoneOffset
• second(optional): integer(int32)
• year(optional): integer(int32)
• zone(optional): object ZoneId

{
    "type":"object",
    "properties":{
        "offset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "zone":{
            "$ref":"#/definitions/ZoneId"
        },
        "dayOfYear":{
            "type":"integer",
            "format":"int32"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "format":"int32"
        },
        "year":{
            "type":"integer",
            "format":"int32"
        },
        "monthValue":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        },
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "chronology":{
            "$ref":"#/definitions/Chronology"
        }
    }
}

Nested Schema : jobProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The properties used to bind with actions",
    "additionalProperties":{
        "type":"string"
    }
}

The properties used to bind with actions

Nested Schema : ReferenceTaskConfig

Type: object

Show Source

• isDependency(optional): boolean
  Default Value: false

  Example: false
• namePath(optional): string
  Example: null
• namespace(optional): object Number
• referenceName(optional): string
  Example: connectionTypeRef
• refObjectType(optional): string
  The full name of the design model class for the referenced object

  Example: null
• uoid(optional): string
  Example: null
• uoidPath(optional): string
  Example: null

{
    "type":"object",
    "properties":{
        "uoidPath":{
            "type":"string",
            "example":"null"
        },
        "namePath":{
            "type":"string",
            "example":"null"
        },
        "refObjectType":{
            "type":"string",
            "example":"null",
            "description":"The full name of the design model class for the referenced object"
        },
        "isDependency":{
            "type":"boolean",
            "example":"false",
            "default":false
        },
        "namespace":{
            "$ref":"#/definitions/Number"
        },
        "referenceName":{
            "type":"string",
            "example":"connectionTypeRef"
        },
        "uoid":{
            "type":"string",
            "example":"null"
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• isDependency(optional): boolean
  Default Value: false

  Example: false
• namePath(optional): string
  Example: null
• namespace(optional): object Number
• referenceName(optional): string
  Example: connectionTypeRef
• refObjectType(optional): string
  The full name of the design model class for the referenced object

  Example: null
• uoid(optional): string
  Example: null
• uoidPath(optional): string
  Example: null

{
    "type":"object",
    "properties":{
        "uoidPath":{
            "type":"string",
            "example":"null"
        },
        "namePath":{
            "type":"string",
            "example":"null"
        },
        "refObjectType":{
            "type":"string",
            "example":"null",
            "description":"The full name of the design model class for the referenced object"
        },
        "isDependency":{
            "type":"boolean",
            "example":"false",
            "default":false
        },
        "namespace":{
            "$ref":"#/definitions/Number"
        },
        "referenceName":{
            "type":"string",
            "example":"connectionTypeRef"
        },
        "uoid":{
            "type":"string",
            "example":"null"
        }
    }
}

Nested Schema : Number

Type: object

Nested Schema : Action

Type: object

A DIPC Job Action

Show Source

• actionOrder(optional): integer(int32)
• actionType(optional): string
  Allowed Values: [ "createProcessAction", "startProcessAction" ]

  actionType
• dependencyConfig(optional): object DependencyConfig
• errorMessage(optional): string
• informationMessage(optional): string
• informationSummary(optional): string
• inputParams(optional): object inputParams
  Additional Properties Allowed: additionalProperties

  Input parameters for this Action
• jobId(optional): string
  UOID of the Job that contains this Action
• jobRef(optional): object ReferenceJob
• name(optional): string
  Example: MyObject
• objectStatus(optional): integer(int32)
• outputParams(optional): object outputParams
  Additional Properties Allowed: additionalProperties

  Output parameters from this Action
• processDefinitionId(optional): string
  The UOID of the ProcessDefinition Table record that stores the exact details of the process to be executed.
• processExecutionHandler(optional): string
  Allowed Values: [ "replication", "elt", "dipcAction", "datalake", "dataValidation" ]

  Runtime engine that needs to handle this Action
• processId(optional): string
  UOID of the runnable/running Process that has been created for executing this Action
• processInstanceRef(optional): string
  Reference to the process instance
• processName(optional): string
  The logical name of the ProcessDefinition record.
• state(optional): string
  Allowed Values: [ "BP", "FL", "PR", "PS", "RN", "SU", "TRQ", "BT", "TR", "WT", "PO", "BS", "ST", "SRQ", "BR", "RSQ", "WRN" ]

  Execution state of this Action

{
    "type":"object",
    "properties":{
        "objectStatus":{
            "type":"integer",
            "format":"int32"
        },
        "jobRef":{
            "$ref":"#/definitions/ReferenceJob"
        },
        "actionType":{
            "type":"string",
            "description":"actionType",
            "enum":[
                "createProcessAction",
                "startProcessAction"
            ]
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The UOID of the ProcessDefinition Table record that stores the exact details of the process to be executed."
        },
        "processName":{
            "type":"string",
            "description":"The logical name of the ProcessDefinition record."
        },
        "dependencyConfig":{
            "$ref":"#/definitions/DependencyConfig"
        },
        "inputParams":{
            "type":"object",
            "description":"Input parameters for this Action",
            "additionalProperties":{
                "type":"string"
            }
        },
        "outputParams":{
            "type":"object",
            "description":"Output parameters from this Action",
            "additionalProperties":{
                "type":"string"
            }
        },
        "processExecutionHandler":{
            "type":"string",
            "description":"Runtime engine that needs to handle this Action",
            "enum":[
                "replication",
                "elt",
                "dipcAction",
                "datalake",
                "dataValidation"
            ]
        },
        "state":{
            "type":"string",
            "description":"Execution state of this Action",
            "enum":[
                "BP",
                "FL",
                "PR",
                "PS",
                "RN",
                "SU",
                "TRQ",
                "BT",
                "TR",
                "WT",
                "PO",
                "BS",
                "ST",
                "SRQ",
                "BR",
                "RSQ",
                "WRN"
            ]
        },
        "jobId":{
            "type":"string",
            "description":"UOID of the Job that contains this Action"
        },
        "processId":{
            "type":"string",
            "description":"UOID of the runnable/running Process that has been created for executing this Action"
        },
        "processInstanceRef":{
            "type":"string",
            "description":"Reference to the process instance"
        },
        "errorMessage":{
            "type":"string"
        },
        "informationSummary":{
            "type":"string"
        },
        "informationMessage":{
            "type":"string"
        },
        "actionOrder":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "example":"MyObject"
        }
    },
    "description":"A DIPC Job Action"
}

Nested Schema : DependencyConfig

Type: object

Show Source

• dependencies(optional): array dependencies

{
    "type":"object",
    "properties":{
        "dependencies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DependencyElement"
            }
        }
    }
}

Nested Schema : inputParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Input parameters for this Action",
    "additionalProperties":{
        "type":"string"
    }
}

Input parameters for this Action

Nested Schema : ReferenceJob

Type: object

Show Source

• isDependency(optional): boolean
  Default Value: false

  Example: false
• namePath(optional): string
  Example: null
• namespace(optional): object Number
• referenceName(optional): string
  Example: connectionTypeRef
• refObjectType(optional): string
  The full name of the design model class for the referenced object

  Example: null
• uoid(optional): string
  Example: null
• uoidPath(optional): string
  Example: null

{
    "type":"object",
    "properties":{
        "uoidPath":{
            "type":"string",
            "example":"null"
        },
        "namePath":{
            "type":"string",
            "example":"null"
        },
        "refObjectType":{
            "type":"string",
            "example":"null",
            "description":"The full name of the design model class for the referenced object"
        },
        "isDependency":{
            "type":"boolean",
            "example":"false",
            "default":false
        },
        "namespace":{
            "$ref":"#/definitions/Number"
        },
        "referenceName":{
            "type":"string",
            "example":"connectionTypeRef"
        },
        "uoid":{
            "type":"string",
            "example":"null"
        }
    }
}

Nested Schema : outputParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Output parameters from this Action",
    "additionalProperties":{
        "type":"string"
    }
}

Output parameters from this Action

Nested Schema : dependencies

Type: array

Show Source

• Array of: object DependencyElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DependencyElement"
    }
}

Nested Schema : DependencyElement

Type: object

Show Source

• actionProceedState(optional): string
  Allowed Values: [ "BP", "FL", "PR", "PS", "RN", "SU", "TRQ", "BT", "TR", "WT", "PO", "BS", "ST", "SRQ", "BR", "RSQ", "WRN" ]
• dependencyActionId(optional): string

{
    "type":"object",
    "properties":{
        "dependencyActionId":{
            "type":"string"
        },
        "actionProceedState":{
            "type":"string",
            "enum":[
                "BP",
                "FL",
                "PR",
                "PS",
                "RN",
                "SU",
                "TRQ",
                "BT",
                "TR",
                "WT",
                "PO",
                "BS",
                "ST",
                "SRQ",
                "BR",
                "RSQ",
                "WRN"
            ]
        }
    }
}

Nested Schema : Chronology

Type: object

Show Source

• calendarType(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "calendarType":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneOffset

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules
• totalSeconds(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalSeconds":{
            "type":"integer",
            "format":"int32"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneId

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules

{
    "type":"object",
    "properties":{
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset(optional): boolean
  Default Value: false
• transitionRules(optional): array transitionRules
• transitions(optional): array transitions

{
    "type":"object",
    "properties":{
        "fixedOffset":{
            "type":"boolean",
            "default":false
        },
        "transitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransition"
            }
        },
        "transitionRules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransitionRule"
            }
        }
    }
}

Nested Schema : transitionRules

Type: array

Show Source

• Array of: object ZoneOffsetTransitionRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransitionRule"
    }
}

Nested Schema : transitions

Type: array

Show Source

• Array of: object ZoneOffsetTransition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransition"
    }
}

Nested Schema : ZoneOffsetTransitionRule

Type: object

Show Source

• dayOfMonthIndicator(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime(optional): object LocalTime
• midnightEndOfDay(optional): boolean
  Default Value: false
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• standardOffset(optional): object ZoneOffset
• timeDefinition(optional): string
  Allowed Values: [ "UTC", "WALL", "STANDARD" ]

{
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "timeDefinition":{
            "type":"string",
            "enum":[
                "UTC",
                "WALL",
                "STANDARD"
            ]
        },
        "standardOffset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour(optional): integer(int32)
• minute(optional): integer(int32)
• nano(optional): integer(int32)
• second(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ZoneOffsetTransition

Type: object

Show Source

• dateTimeAfter(optional): string(date-time)
• dateTimeBefore(optional): string(date-time)
• duration(optional): object Duration
• gap(optional): boolean
  Default Value: false
• instant(optional): object Instant
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• overlap(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "gap":{
            "type":"boolean",
            "default":false
        },
        "overlap":{
            "type":"boolean",
            "default":false
        },
        "dateTimeAfter":{
            "type":"string",
            "format":"date-time"
        },
        "dateTimeBefore":{
            "type":"string",
            "format":"date-time"
        },
        "instant":{
            "$ref":"#/definitions/Instant"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

• nano(optional): integer(int32)
• negative(optional): boolean
  Default Value: false
• seconds(optional): integer(int64)
• units(optional): array units
• zero(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "seconds":{
            "type":"integer",
            "format":"int64"
        },
        "negative":{
            "type":"boolean",
            "default":false
        },
        "zero":{
            "type":"boolean",
            "default":false
        },
        "units":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemporalUnit"
            }
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Instant

Type: object

Show Source

• epochSecond(optional): integer(int64)
• nano(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "epochSecond":{
            "type":"integer",
            "format":"int64"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : units

Type: array

Show Source

• Array of: object TemporalUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemporalUnit"
    }
}

Nested Schema : TemporalUnit

Type: object

Show Source

• dateBased(optional): boolean
  Default Value: false
• duration(optional): object Duration
• durationEstimated(optional): boolean
  Default Value: false
• timeBased(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "dateBased":{
            "type":"boolean",
            "default":false
        },
        "durationEstimated":{
            "type":"boolean",
            "default":false
        },
        "timeBased":{
            "type":"boolean",
            "default":false
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

202 Response

Task submitted for execution

Body ()

Root Schema : JobExecutionInfo

Type: object

Show Source

• duration(optional): string
• endTime(optional): object ZonedDateTime
• jobId(optional): string
• jobName(optional): string
• links(optional): array links
• startTime(optional): object ZonedDateTime
• status(optional): string
• summaryMessage(optional): string

{
    "type":"object",
    "properties":{
        "summaryMessage":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "jobName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "startTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "endTime":{
            "$ref":"#/definitions/ZonedDateTime"
        },
        "duration":{
            "type":"string"
        }
    }
}

Nested Schema : ZonedDateTime

Type: object

Show Source

• chronology(optional): object Chronology
• dayOfMonth(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• dayOfYear(optional): integer(int32)
• hour(optional): integer(int32)
• minute(optional): integer(int32)
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• monthValue(optional): integer(int32)
• nano(optional): integer(int32)
• offset(optional): object ZoneOffset
• second(optional): integer(int32)
• year(optional): integer(int32)
• zone(optional): object ZoneId

{
    "type":"object",
    "properties":{
        "offset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "zone":{
            "$ref":"#/definitions/ZoneId"
        },
        "dayOfYear":{
            "type":"integer",
            "format":"int32"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "format":"int32"
        },
        "year":{
            "type":"integer",
            "format":"int32"
        },
        "monthValue":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        },
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "chronology":{
            "$ref":"#/definitions/Chronology"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Chronology

Type: object

Show Source

• calendarType(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "calendarType":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneOffset

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules
• totalSeconds(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalSeconds":{
            "type":"integer",
            "format":"int32"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneId

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules

{
    "type":"object",
    "properties":{
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset(optional): boolean
  Default Value: false
• transitionRules(optional): array transitionRules
• transitions(optional): array transitions

{
    "type":"object",
    "properties":{
        "fixedOffset":{
            "type":"boolean",
            "default":false
        },
        "transitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransition"
            }
        },
        "transitionRules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransitionRule"
            }
        }
    }
}

Nested Schema : transitionRules

Type: array

Show Source

• Array of: object ZoneOffsetTransitionRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransitionRule"
    }
}

Nested Schema : transitions

Type: array

Show Source

• Array of: object ZoneOffsetTransition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ZoneOffsetTransition"
    }
}

Nested Schema : ZoneOffsetTransitionRule

Type: object

Show Source

• dayOfMonthIndicator(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime(optional): object LocalTime
• midnightEndOfDay(optional): boolean
  Default Value: false
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• standardOffset(optional): object ZoneOffset
• timeDefinition(optional): string
  Allowed Values: [ "UTC", "WALL", "STANDARD" ]

{
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "timeDefinition":{
            "type":"string",
            "enum":[
                "UTC",
                "WALL",
                "STANDARD"
            ]
        },
        "standardOffset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour(optional): integer(int32)
• minute(optional): integer(int32)
• nano(optional): integer(int32)
• second(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ZoneOffsetTransition

Type: object

Show Source

• dateTimeAfter(optional): string(date-time)
• dateTimeBefore(optional): string(date-time)
• duration(optional): object Duration
• gap(optional): boolean
  Default Value: false
• instant(optional): object Instant
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• overlap(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "gap":{
            "type":"boolean",
            "default":false
        },
        "overlap":{
            "type":"boolean",
            "default":false
        },
        "dateTimeAfter":{
            "type":"string",
            "format":"date-time"
        },
        "dateTimeBefore":{
            "type":"string",
            "format":"date-time"
        },
        "instant":{
            "$ref":"#/definitions/Instant"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

• nano(optional): integer(int32)
• negative(optional): boolean
  Default Value: false
• seconds(optional): integer(int64)
• units(optional): array units
• zero(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "seconds":{
            "type":"integer",
            "format":"int64"
        },
        "negative":{
            "type":"boolean",
            "default":false
        },
        "zero":{
            "type":"boolean",
            "default":false
        },
        "units":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemporalUnit"
            }
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Instant

Type: object

Show Source

• epochSecond(optional): integer(int64)
• nano(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "epochSecond":{
            "type":"integer",
            "format":"int64"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : units

Type: array

Show Source

• Array of: object TemporalUnit

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemporalUnit"
    }
}

Nested Schema : TemporalUnit

Type: object

Show Source

• dateBased(optional): boolean
  Default Value: false
• duration(optional): object Duration
• durationEstimated(optional): boolean
  Default Value: false
• timeBased(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "dateBased":{
            "type":"boolean",
            "default":false
        },
        "durationEstimated":{
            "type":"boolean",
            "default":false
        },
        "timeBased":{
            "type":"boolean",
            "default":false
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• relation(optional): string

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

400 Response

Task already has a running Job or is invalid.

404 Response

Task with given name was not found or Task name was invalid

500 Response

Error occurred while processing request. Check server logs.

Back to Top