Retrieve a falloutException by ID
get
https://serverRoot/fallout/v2.0/falloutException/{id}
This operation retrieves a falloutException entity. Attribute selection is enabled for all first level attributes.
Request
Path Parameters
-
id(required): string
Identifier of the falloutException.
Query Parameters
-
fields: string
Provide comma-separated properties in the response. Example: GET /falloutException/3424242?fields=customerName,orderId,state,requestedCompletionDate
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
The operation is successful.
Root Schema : falloutException
Type:
Show Source
object-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
additionalFalloutProperties: array
additionalFalloutProperties
Additional fallout properties list.
-
affectedLines: string
Comma-separated lineIds or names.
-
attributes: array
attributes
The fallout custom exception attributes.
-
category: string
Represent a business type of the fallout exception.
-
creationDate: string
(date-time)
The date on which the falloutException was created.
-
customerName: string
Customer Name details.
-
externalId: string
From TMF 622 payload - externalId.
-
fullfillmentFunction: string
Product fulfillment Function details.
-
href: string
Hyperlink. A reference to the falloutException entity.
-
id: string
Unique identifier of the falloutException.
-
isTmfOrder: boolean
This flag value is set to true if order is TMF order. Else, set to false.
-
lastUpdatedDate: string
(date-time)
The date on which the falloutException was last updated.
-
message: string
Description or reason of the error.
-
orderId: integer
Orchestration order ID.
-
orderOverdue: boolean
This flag value is set to true if order is overdue. Else, set to false.
-
orderType: string
orderType details.
-
productNames: array
productNames
List of Product Names.
-
recentAction: string
The last fallout action submitted for the falloutException
-
requestedCompletionDate: string
(date-time)
The requested completion date from OSM.
-
retriedFalloutExceptions: array
retriedFalloutExceptions
An array of unique identifiers for Fallout Exceptions created after Fallout Action 'retry' was submitted on the FE belonging to the same task. If no retries occurred, the array will be empty.
-
state: string
Allowed Values:
[ "created", "resolving", "completed", "completed.implicit" ]Possible values for the state of the fallout. -
taskName: string
TaskName details.
-
taskStatuses: array
taskStatuses
List of task statuses
Nested Schema : additionalFalloutProperties
Type:
arrayAdditional fallout properties list.
Show Source
-
Array of:
object additionalFalloutProperties
This holds all the additional properties such as schema details.
Nested Schema : attributes
Type:
arrayThe fallout custom exception attributes.
Show Source
-
Array of:
object attribute
This holds all additional attributes for the OSM user interface. For example, 'status'. The API does not provide filtering on the attributes.
Nested Schema : productNames
Type:
arrayList of Product Names.
Show Source
-
Array of:
object productNames
List of ProductNames.
Nested Schema : retriedFalloutExceptions
Type:
arrayAn array of unique identifiers for Fallout Exceptions created after Fallout Action 'retry' was submitted on the FE belonging to the same task. If no retries occurred, the array will be empty.
Show Source
Nested Schema : additionalFalloutProperties
Type:
objectThis holds all the additional properties such as schema details.
Show Source
-
name: string
The name of the additional fallout properties. Example, 'schema'.
-
value: string
The value of the additional fallout properties.
Nested Schema : attribute
Type:
objectThis holds all additional attributes for the OSM user interface. For example, 'status'. The API does not provide filtering on the attributes.
Show Source
-
name: string
The name of the attribute. For example, 'status' owned by the user interface.
-
value: string
The value of the attribute. For example, the value of 'status', handled by UI backend.
Nested Schema : productNames
Type:
objectList of ProductNames.
Show Source
-
name: string
Product Name details.
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Possible list of error codes returned as part of ProductOrder API response.
-
message: string
More details and corrective actions related to the error that can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Possible list of error codes returned as part of ProductOrder API response.
-
message: string
More details and corrective actions related to the error that can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Possible list of error codes returned as part of ProductOrder API response.
-
message: string
More details and corrective actions related to the error that can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Possible list of error codes returned as part of ProductOrder API response.
-
message: string
More details and corrective actions related to the error that can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Possible list of error codes returned as part of ProductOrder API response.
-
message: string
More details and corrective actions related to the error that can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error that can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.