Jump to

• Request
• Response

Action Program Event

post

https://server:port/rest/apis/cross/service/programEvent/lifecycle

This REST web service takes requests for transitioning the status of created program events

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• action: string
  Allowed Values: [ "F1CN", "F1CO", "X1IP", "X1SD" ]

  Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule
• cancelReason: string
  Optional message sent when posting an event cancel action.
• eventExternalIdentifier: string
  Unique identifier of the event from the external source application.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "description":"Unique identifier of the event from the external source application."
        },
        "action":{
            "type":"string",
            "enum":[
                "F1CN",
                "F1CO",
                "X1IP",
                "X1SD"
            ],
            "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
        },
        "cancelReason":{
            "type":"string",
            "description":"Optional message sent when posting an event cancel action. "
        }
    },
    "xml":{
        "name":"X1ActPrgEvt"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• action: string
  Allowed Values: [ "F1CN", "F1CO", "X1IP", "X1SD" ]

  Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule
• cancelReason: string
  Optional message sent when posting an event cancel action.
• eventExternalIdentifier: string
  Unique identifier of the event from the external source application.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "description":"Unique identifier of the event from the external source application."
        },
        "action":{
            "type":"string",
            "enum":[
                "F1CN",
                "F1CO",
                "X1IP",
                "X1SD"
            ],
            "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
        },
        "cancelReason":{
            "type":"string",
            "description":"Optional message sent when posting an event cancel action. "
        }
    },
    "xml":{
        "name":"X1ActPrgEvt"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1ActPrgEvt

Type: object

Show Source

• action: string
  Allowed Values: [ "F1CN", "F1CO", "X1IP", "X1SD" ]

  Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule
• cancelReason: string
  Optional message sent when posting an event cancel action.
• eventExternalIdentifier: string
  Unique identifier of the event from the external source application.
• nextActions: array nextActions
• status: string
  Maximum Length: 12

  Status

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "description":"Unique identifier of the event from the external source application."
        },
        "action":{
            "type":"string",
            "enum":[
                "F1CN",
                "F1CO",
                "X1IP",
                "X1SD"
            ],
            "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
        },
        "cancelReason":{
            "type":"string",
            "description":"Optional message sent when posting an event cancel action. "
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "F1CN",
                            "F1CO",
                            "X1IP",
                            "X1SD"
                        ],
                        "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1ActPrgEvt"
    }
}

Nested Schema : nextActions

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "F1CN",
                    "F1CO",
                    "X1IP",
                    "X1SD"
                ],
                "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Allowed Values: [ "F1CN", "F1CO", "X1IP", "X1SD" ]

  Program event statuses defined and managed in the external source application. * `F1CN` - cancel, * `F1CO` - complete, * `X1IP` - in progress, * `X1SD` - schedule

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "F1CN",
                "F1CO",
                "X1IP",
                "X1SD"
            ],
            "description":"Program event statuses defined and managed in the external source application. \n* `F1CN` - cancel,\n* `F1CO` - complete,\n* `X1IP` - in progress,\n* `X1SD` - schedule"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object problemDetailDocument_serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object problemDetailDocument_serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top