Operation

delete /otn/PathSyncScheduler/{jobName}
deleteJob (deleteJob : /otn/PathSyncScheduler/{jobName})
deleteJob

Path parameters

Name

IsRequired

Description

Enum

jobName required jobName ---

Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /otn/PathSyncScheduler
    getPathSyncJob (getPathSyncJob : /otn/PathSyncScheduler)
    getPathSyncJob


    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    put /otn/PathSyncScheduler/{jobName}
    modifyPathSyncJob (modifyPathSyncJob : /otn/PathSyncScheduler/{jobName})
    modifyPathSyncJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobName required jobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data JobScheduleWrapper ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /otn/PathSyncScheduler
    schedulePathSync (schedulePathSync : /otn/PathSyncScheduler)
    schedulePathSync

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional data JobScheduleWrapper ---

    Return type
  • DeferredResult«OtnConnectionResponse»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«OtnConnectionResponse»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    DeferredResult«OtnConnectionResponse»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    JobScheduleEnd

    Name

    Type

    Description

    Enum

    type String string --- [NEVER, REPEAT, TIMELINE]
    repeat Integer integer --- ---
    endDate String string --- ---
    endTime String string --- ---

    JobScheduleFrequency

    Name

    Type

    Description

    Enum

    hourlyInterval Integer integer --- ---
    weekdays array[Integer] integer --- ---
    type String string --- [ONCE, HOURLY, DAILY, WEEKLY, SECONDS]
    hourlyIntervaly Integer integer --- ---

    JobScheduleWrapper

    Name

    Type

    Description

    Enum

    startDate String string --- ---
    startTime String string --- ---
    frequency JobScheduleFrequency JobScheduleFrequency --- ---
    ends JobScheduleEnd JobScheduleEnd --- ---
    jobName String string --- ---
    operation String string --- ---
    jobHandle Long long --- ---
    persist Boolean boolean --- ---

    OtnConnectionResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    messageId String string --- ---
    messageSeverity String string --- ---
    status String string --- ---
    connectionName String string --- ---
    connectionId Integer integer --- ---
    orderNumber String string --- ---
    orderId String string --- ---
    orderStep Integer integer --- ---
    id String string --- ---
    errorField String string --- ---
    errorValue String string --- ---