REST API Reference for Oracle Communications Order and Service Management Cloud Native

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.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

The operation is successful.

Root Schema : falloutException

Type: object

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.
additionalFalloutProperties: array additionalFalloutProperties

Additional fallout properties list.
affectedLines: string

Comma-separated lineIds or names.
attributes: array attributes

The fallout custom exception attributes.
category: string

Represents 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.
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 the order is overdue. Otherwise, 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.
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.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the falloutException."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink. A reference to the falloutException entity."
        },
        "creationDate":{
            "type":"string",
            "description":"The date on which the falloutException was created.",
            "format":"date-time"
        },
        "message":{
            "type":"string",
            "description":"Description or reason of the error."
        },
        "orderType":{
            "type":"string",
            "description":"orderType details."
        },
        "customerName":{
            "type":"string",
            "description":"Customer name details."
        },
        "productNames":{
            "type":"array",
            "description":"List of product names.",
            "items":{
                "$ref":"#/components/schemas/productNames"
            }
        },
        "fullfillmentFunction":{
            "type":"string",
            "description":"Product fulfillment function details."
        },
        "taskName":{
            "type":"string",
            "description":"TaskName details."
        },
        "orderId":{
            "type":"integer",
            "description":"Orchestration order ID."
        },
        "externalId":{
            "type":"string",
            "description":"From TMF 622 payload - externalId."
        },
        "category":{
            "type":"string",
            "description":"Represents a business type of the fallout exception."
        },
        "orderOverdue":{
            "type":"boolean",
            "description":"This flag value is set to true if the order is overdue. Otherwise, set to false."
        },
        "affectedLines":{
            "type":"string",
            "description":"Comma-separated lineIds or names."
        },
        "requestedCompletionDate":{
            "type":"string",
            "description":"The requested completion date from OSM.",
            "format":"date-time"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"The date on which the falloutException was last updated.",
            "format":"date-time"
        },
        "recentAction":{
            "type":"string",
            "description":"The last fallout action submitted for the falloutException."
        },
        "state":{
            "$ref":"#/components/schemas/falloutExceptionStateType"
        },
        "attributes":{
            "type":"array",
            "description":"The fallout custom exception attributes.",
            "items":{
                "$ref":"#/components/schemas/attribute"
            }
        },
        "additionalFalloutProperties":{
            "type":"array",
            "description":"Additional fallout properties list.",
            "items":{
                "$ref":"#/components/schemas/additionalFalloutProperties"
            }
        },
        "taskStatuses":{
            "type":"array",
            "description":"List of task statuses.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : additionalFalloutProperties

Type: array

Additional fallout properties list.

Show Source

Array of: object additionalFalloutProperties

This holds all the additional properties such as schema details.

{
    "type":"array",
    "description":"Additional fallout properties list.",
    "items":{
        "$ref":"#/components/schemas/additionalFalloutProperties"
    }
}

Nested Schema : attributes

Type: array

The 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.

{
    "type":"array",
    "description":"The fallout custom exception attributes.",
    "items":{
        "$ref":"#/components/schemas/attribute"
    }
}

Nested Schema : productNames

Type: array

List of product names.

Show Source

Array of: object productNames

List of ProductNames.

{
    "type":"array",
    "description":"List of product names.",
    "items":{
        "$ref":"#/components/schemas/productNames"
    }
}

Nested Schema : taskStatuses

Type: array

List of task statuses.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of task statuses.",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalFalloutProperties

Type: object

This 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.

{
    "description":"This holds all the additional properties such as schema details.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the additional fallout properties. Example, 'schema'."
        },
        "value":{
            "type":"string",
            "description":"The value of the additional fallout properties."
        }
    }
}

Nested Schema : attribute

Type: object

This 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.

{
    "description":"This holds all additional attributes for the OSM user interface. For example, 'status'. The API does not provide filtering on the attributes.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the attribute. For example, 'status' owned by the user interface."
        },
        "value":{
            "type":"string",
            "description":"The value of the attribute. For example, the value of 'status', handled by UI backend."
        }
    }
}

Nested Schema : productNames

Type: object

List of ProductNames.

Show Source

name: string

Product Name details.

{
    "description":"List of ProductNames.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Product Name details."
        }
    }
}

400 Response

Bad Request

Root Schema : Error

Type: object

Used 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

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error shown to a client user.
reason(required): string

Explanation of the reason for the error shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
state: string

HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

401 Response

Unauthorized

Root Schema : Error

Type: object

Used 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

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error shown to a client user.
reason(required): string

Explanation of the reason for the error shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
state: string

HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

403 Response

Forbidden

Root Schema : Error

Type: object

Used 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

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error shown to a client user.
reason(required): string

Explanation of the reason for the error shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
state: string

HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

404 Response

Not Found

Root Schema : Error

Type: object

Used 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

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error shown to a client user.
reason(required): string

Explanation of the reason for the error shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
state: string

HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Used 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

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error shown to a client user.
reason(required): string

Explanation of the reason for the error shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
state: string

HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}