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

Suspend a Service Order

post

https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/suspendServiceOrder

This operation creates a SuspendServiceOrder entity.

Request

There are no request parameters for this operation.

Supported Media Types

application/json;charset=utf-8

Root Schema : schema

Type: object

OSM extension to define the payload for abort or resume requests.

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.
productOrder: object ProductOrderRef

ProductOrder (ProductOrder). The product order that the recommendation is related to.
reason: string

Reason for the lifecycle operation (resume, abort) request.

{
    "type":"object",
    "description":"OSM extension to define the payload for abort or resume requests.",
    "properties":{
        "reason":{
            "type":"string",
            "description":"Reason for the lifecycle operation (resume, abort) request."
        },
        "productOrder":{
            "$ref":"#/components/schemas/ProductOrderRef"
        },
        "@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."
        }
    }
}

Nested Schema : ProductOrderRef

Type: object

ProductOrder (ProductOrder). The product order that the recommendation is related to.

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@referredType: string

The actual type of the target instance when needed for disambiguation.
@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.
href: string

Reference of the related entity.
id(required): string

Unique identifier of a related entity.
name: string

Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@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."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"ProductOrder (ProductOrder). The product order that the recommendation is related to."
}

Response

Supported Media Types

application/json;charset=utf-8

201 Response

Created

Root Schema : SuspendServiceOrderOSM

Type: object

OSM extension to define the SuspendServiceOrder structure.

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.
error: object Error

Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
href: string

Hyperlink to access the suspension request.
id: string

ID of the SuspendServiceOrder resource (this is not an order id).
reason: string

Reason for the service order suspension request.
serviceOrder(required): object ServiceOrderRef

Service Order reference. Useful to understand through which Service order the service was instantiated in the service inventory.
state: string

Allowed Values: [ "acknowledged", "terminatedWithError", "inProgress", "done", "queued", "terminated", "skipped" ]

Possible values for the state of a task.

{
    "required":[
        "serviceOrder"
    ],
    "type":"object",
    "description":"OSM extension to define the SuspendServiceOrder structure.",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the SuspendServiceOrder resource (this is not an order id)."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the suspension request."
        },
        "reason":{
            "type":"string",
            "description":"Reason for the service order suspension request."
        },
        "serviceOrder":{
            "$ref":"#/components/schemas/ServiceOrderRef"
        },
        "state":{
            "$ref":"#/components/schemas/TaskStateType"
        },
        "error":{
            "$ref":"#/components/schemas/Error",
            "description":"Error details should be provided when the state is failed."
        },
        "@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."
        }
    }
}

Nested 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)."
}

Nested Schema : ServiceOrderRef

Type: object

Service Order reference. Useful to understand through which Service order the service was instantiated in the service inventory.

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@referredType: string

The actual type of the target instance when needed for disambiguation.
@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 Extensible name.
href: string (uri)

Hyperlink reference.
id(required): string

Unique identifier.
name: string

Name of the related service order.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "format":"uri"
        },
        "name":{
            "type":"string",
            "description":"Name of the related service order."
        },
        "@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 Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Service Order reference. Useful to understand through which Service order the service was instantiated in the service inventory."
}

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)."
}

405 Response

Method Not allowed

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)."
}

409 Response

Conflict

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)."
}