Jump to

• Request
• Response

Get Cut Process

get

/rest/apis/customer/collections/cutProcesses/{cutProcessId}

Request

Path Parameters

• cutProcessId(required): string
  Cut Process ID is the system-assigned unique identifier of the cut process.

  Example:

  460555550000

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1CutProcess

Type: object

Show Source

• _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 ` - Inactive

  Example: 10
• statusReason: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Cut Status Reason * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by User

  Example: 20
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "name":{
            "type":"string",
            "description":"(name)"
        },
        "cutProcessId":{
            "type":"string",
            "maxLength":"12",
            "description":"Cut Process ID is the system-assigned unique identifier of the cut process.",
            "example":"460555550000"
        },
        "overdueProcess":{
            "type":"object",
            "properties":{
                "overdueProcessId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Overdue Process ID is the system-assigned unique identifier of the cut process.",
                    "example":"460352888888"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "overdueEvent":{
            "type":"number",
            "maximum":"999",
            "minimum":"0",
            "description":"Overdue Event  that created the cut process."
        },
        "serviceAgreement":{
            "type":"object",
            "description":"Service Agreement identifies the service agreement being cut.",
            "properties":{
                "serviceAgreement":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Service Agreement"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Status defines the state of the cut process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"10"
        },
        "statusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Cut Status Reason\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"20"
        },
        "cutProcessTemplate":{
            "type":"object",
            "description":"Cut Process Template defines the template that was used to create the cut process's events.",
            "properties":{
                "cutProcessTemplate":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Cut Process Template defines the template that was used to create the cut process's events.",
                    "example":"STDCUT"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the creation date/time of the cut process.",
            "example":"2005-04-18T07:50:51-04:00"
        },
        "inactiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Inactive Date/Time is the date and time that the cut process became Inactive.",
            "example":"2008-06-04T15:12:44-04:00"
        },
        "comments":{
            "type":"string",
            "maxLength":"2000",
            "description":"Enter any Comments about the cut process."
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "cutProcessId":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Cut Process ID"
                            },
                            "eventSequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
                            },
                            "statusDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Status Date/Time",
                                "example":"2008-06-04T15:13:00-04:00"
                            },
                            "cancellationComment":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Enter any Comments about cancelling the cut event."
                            },
                            "cutEventType":{
                                "type":"object",
                                "properties":{
                                    "cutEventType":{
                                        "type":"string",
                                        "maxLength":"12",
                                        "description":"Cut Event Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "daysAfterPreviousResponse":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"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":{
                                "type":"boolean",
                                "description":"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"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                                "example":"2005-04-19"
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Version"
                            },
                            "eventDependencies":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "cutProcessId":{
                                                    "type":"string",
                                                    "maxLength":"12",
                                                    "description":"Cut Process ID"
                                                },
                                                "eventSequence2":{
                                                    "type":"number",
                                                    "maximum":"999",
                                                    "minimum":"-999",
                                                    "description":"Event Sequence is the unique identifier of the event.",
                                                    "example":"10"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":"999",
                                                    "minimum":"-999",
                                                    "description":"Sequence Number",
                                                    "example":"11"
                                                },
                                                "dependentOnSequence":{
                                                    "type":"number",
                                                    "maximum":"999",
                                                    "minimum":"-999",
                                                    "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":"99999",
                                                    "minimum":"-99999",
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Premise identifies the service agreement's characteristic premise (if any)."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    },
    "xml":{
        "name":"C1CutProcess"
    }
}

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

{
    "type":"object",
    "description":"Cut Process Template defines the template that was used to create the cut process's events.",
    "properties":{
        "cutProcessTemplate":{
            "type":"string",
            "maxLength":"12",
            "description":"Cut Process Template defines the template that was used to create the cut process's events.",
            "example":"STDCUT"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "cutProcessId":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Cut Process ID"
                    },
                    "eventSequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
                    },
                    "statusDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Status Date/Time",
                        "example":"2008-06-04T15:13:00-04:00"
                    },
                    "cancellationComment":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Enter any Comments about cancelling the cut event."
                    },
                    "cutEventType":{
                        "type":"object",
                        "properties":{
                            "cutEventType":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Cut Event Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "daysAfterPreviousResponse":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"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":{
                        "type":"boolean",
                        "description":"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"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                        "example":"2005-04-19"
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Version"
                    },
                    "eventDependencies":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "cutProcessId":{
                                            "type":"string",
                                            "maxLength":"12",
                                            "description":"Cut Process ID"
                                        },
                                        "eventSequence2":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"Event Sequence is the unique identifier of the event.",
                                            "example":"10"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"Sequence Number",
                                            "example":"11"
                                        },
                                        "dependentOnSequence":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":"99999",
                                            "minimum":"-99999",
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : overdueProcess

Type: object

Show Source

• _link: string
  _link
• overdueProcessId: string
  Maximum Length: 12

  Overdue Process ID is the system-assigned unique identifier of the cut process.

  Example: 460352888888

{
    "type":"object",
    "properties":{
        "overdueProcessId":{
            "type":"string",
            "maxLength":"12",
            "description":"Overdue Process ID is the system-assigned unique identifier of the cut process.",
            "example":"460352888888"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseId: string
  Maximum Length: 10

  Premise identifies the service agreement's characteristic premise (if any).

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"Premise identifies the service agreement's characteristic premise (if any)."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Service Agreement identifies the service agreement being cut.

Show Source

• _link: string
  _link
• serviceAgreement: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"Service Agreement identifies the service agreement being cut.",
    "properties":{
        "serviceAgreement":{
            "type":"string",
            "maxLength":"10",
            "description":"Service Agreement"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "cutProcessId":{
                "type":"string",
                "maxLength":"12",
                "description":"Cut Process ID"
            },
            "eventSequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "status":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  "
                ],
                "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
            },
            "statusDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Status Date/Time",
                "example":"2008-06-04T15:13:00-04:00"
            },
            "cancellationComment":{
                "type":"string",
                "maxLength":"254",
                "description":"Enter any Comments about cancelling the cut event."
            },
            "cutEventType":{
                "type":"object",
                "properties":{
                    "cutEventType":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Cut Event Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "daysAfterPreviousResponse":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"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":{
                "type":"boolean",
                "description":"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"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                "example":"2005-04-19"
            },
            "version":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Version"
            },
            "eventDependencies":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "cutProcessId":{
                                    "type":"string",
                                    "maxLength":"12",
                                    "description":"Cut Process ID"
                                },
                                "eventSequence2":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"Event Sequence is the unique identifier of the event.",
                                    "example":"10"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"Sequence Number",
                                    "example":"11"
                                },
                                "dependentOnSequence":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":"99999",
                                    "minimum":"-99999",
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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/Time

  Example: 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

{
    "type":"object",
    "properties":{
        "cutProcessId":{
            "type":"string",
            "maxLength":"12",
            "description":"Cut Process ID"
        },
        "eventSequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2008-06-04T15:13:00-04:00"
        },
        "cancellationComment":{
            "type":"string",
            "maxLength":"254",
            "description":"Enter any Comments about cancelling the cut event."
        },
        "cutEventType":{
            "type":"object",
            "properties":{
                "cutEventType":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Cut Event Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "daysAfterPreviousResponse":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"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":{
            "type":"boolean",
            "description":"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"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
            "example":"2005-04-19"
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Version"
        },
        "eventDependencies":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "cutProcessId":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Cut Process ID"
                            },
                            "eventSequence2":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Sequence Number",
                                "example":"11"
                            },
                            "dependentOnSequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : cutEventType

Type: object

Show Source

• _link: string
  _link
• cutEventType: string
  Maximum Length: 12

  Cut Event Type

{
    "type":"object",
    "properties":{
        "cutEventType":{
            "type":"string",
            "maxLength":"12",
            "description":"Cut Event Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : eventDependencies

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "cutProcessId":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Cut Process ID"
                    },
                    "eventSequence2":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence Number",
                        "example":"11"
                    },
                    "dependentOnSequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "cutProcessId":{
                "type":"string",
                "maxLength":"12",
                "description":"Cut Process ID"
            },
            "eventSequence2":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence Number",
                "example":"11"
            },
            "dependentOnSequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
            },
            "version":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 Number

  Example: 11
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "cutProcessId":{
            "type":"string",
            "maxLength":"12",
            "description":"Cut Process ID"
        },
        "eventSequence2":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence Number",
            "example":"11"
        },
        "dependentOnSequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends."
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Version"
        }
    }
}

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 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":{
            "type":"string",
            "maxLength":"60",
            "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":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "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":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : 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":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "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 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":{
            "type":"string",
            "maxLength":"60",
            "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":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "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":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

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

Back to Top