Get Cut Process
get
https://server:port/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1CutProcess
Type:
Show Source
object
-
_self: string
_self
-
comments: string
Maximum Length:
2000
Enter any Comments about the cut process. -
creationDateTime: string
(date-time)
Create Date/Time defines the creation date/time of the cut process.Example:
2005-04-18T07:50:51-04:00
-
cutProcessId: string
Maximum Length:
12
Cut Process ID is the system-assigned unique identifier of the cut process.Example:460555550000
-
cutProcessTemplate: object
cutProcessTemplate
Cut Process Template defines the template that was used to create the cut process's events.
-
events: object
events
-
inactiveDateTime: string
(date-time)
Inactive Date/Time is the date and time that the cut process became Inactive.Example:
2008-06-04T15:12:44-04:00
-
name: string
(name)
-
overdueEvent: number
Minimum Value:
0
Maximum Value:999
Overdue Event that created the cut process. -
overdueProcess: object
overdueProcess
-
premise: object
premise
-
serviceAgreement: object
serviceAgreement
Service Agreement identifies the service agreement being cut.
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Status defines the state of the cut process. * `10 ` - Active, * `20 ` - InactiveExample:10
-
statusReason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Cut Status Reason * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cutProcessTemplate
Type:
object
Cut Process Template defines the template that was used to create the cut process's events.
Show Source
-
_link: string
_link
-
cutProcessTemplate: string
Maximum Length:
12
Cut Process Template defines the template that was used to create the cut process's events.Example:STDCUT
Nested Schema : overdueProcess
Type:
Show Source
object
-
_link: string
_link
-
overdueProcessId: string
Maximum Length:
12
Overdue Process ID is the system-assigned unique identifier of the cut process.Example:460352888888
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise identifies the service agreement's characteristic premise (if any).
Nested Schema : serviceAgreement
Type:
object
Service Agreement identifies the service agreement being cut.
Show Source
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Nested Schema : items
Type:
Show Source
object
-
cancellationComment: string
Maximum Length:
254
Enter any Comments about cancelling the cut event. -
cutEventType: object
cutEventType
-
cutProcessId: string
Maximum Length:
12
Cut Process ID -
daysAfterPreviousResponse: number
Minimum Value:
-999
Maximum Value:999
Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.Example:1
-
dependOnOtherEvents: boolean
If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.Example:
false
-
eventDependencies: object
eventDependencies
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
status: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Event Status: * `10 ` - Pending, * `20 ` - Waiting, * `30 ` - Completed, * `40 ` - Canceled -
statusDateTime: string
(date-time)
Status Date/TimeExample:
2008-06-04T15:13:00-04:00
-
triggerDate: string
(date)
If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.Example:
2005-04-19
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : cutEventType
Type:
Show Source
object
-
_link: string
_link
-
cutEventType: string
Maximum Length:
12
Cut Event Type
Nested Schema : items
Type:
Show Source
object
-
cutProcessId: string
Maximum Length:
12
Cut Process ID -
dependentOnSequence: number
Minimum Value:
-999
Maximum Value:999
When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends. -
eventSequence2: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:11
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
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.