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
Root Schema : schema
Type:
Show Source
object
-
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.
Root Schema : schema
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1ActPrgEvt
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
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
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.