Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Authenticate
• Reading the OpenAPI Specification File
• About Request Headers
• About Additional Query Parameters
• Send Requests
• Testing the REST API at Runtime
• Status Codes

Tasks

• Client Listeners for Product Orders
  • Client listener for CancelProductOrderCreateEvent
  • Client listener for CancelProductOrderStateChangeEvent
  • Client listener for ProductOrderAttributeValueChangeEvent
  • Client listener for ProductOrderCreateEvent
  • Client listener for ProductOrderStateChangeEvent
  • Client listener for ReviseProductOrderCreateEvent
  • Client listener for ReviseProductOrderStateChangeEvent
  • Client listener for SuspendProductOrderCreateEvent
  • Client listener for SuspendProductOrderStateChangeEvent
• Client Listeners for Service Orders
  • Client listener for CancelServiceOrderCreateEvent
  • Client listener for CancelServiceOrderStateChangeEvent
  • Client listener for ReviseServiceOrderCreateEvent
  • Client listener for ReviseServiceOrderStateChangeEvent
  • Client listener for ServiceOrderAttributeValueChangeEvent
  • Client listener for ServiceOrderCreateEvent
  • Client listener for ServiceOrderStateChangeEvent
  • Client listener for SuspendServiceOrderCreateEvent
  • Client listener for SuspendServiceOrderStateChangeEvent
• Manage Fallout Exception v1
  • List or find falloutException objects
  • Retrieve a falloutException by ID
• Manage Fallout Exception v2.0
  • List or find falloutException objects
  • Retrieve a falloutException by ID
  • Submit a falloutAction on the Fallout Exception
  • Submit a falloutAction on the Fallout Order
• Manage Product Orders
  • Abort a Product Order
  • Cancel a Product Order
  • Create a Product Order
  • List or find CancelProductOrder objects
  • List or find ProductOrder objects
  • List or find ReviseProductOrders objects
  • List or find SuspendProductOrder objects
  • Resume a Product Order
  • Retrieve a CancelProductOrder by ID
  • Retrieve a ProductOrder by ID
  • Retrieve a ReviseProductOrder by ID
  • Retrieve a SuspendProductOrder by ID
  • Revise a Product Order
  • Suspend a Product Order
• Manage Service Orders
  • Abort a Service Order
  • Cancel a Service Order
  • Create a Service Order
  • List or find CancelServiceOrder objects
  • List or find ReviseServiceOrder objects
  • List or find ServiceOrder objects
  • List or find SuspendServiceOrder objects
  • Resume a Service Order
  • Retrieve a CancelServiceOrder by ID
  • Retrieve a ReviseServiceOrder by ID
  • Retrieve a ServiceOrder by ID
  • Retrieve a SuspendServiceOrder by ID
  • Revise a Service Order
  • Suspend a Service Order