List or find SuspendServiceOrder objects
get
https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/suspendServiceOrder
This operation lists or finds SuspendServiceOrder entities.
Request
Query Parameters
-
fields: string
Comma-separated properties to be provided in the response.
-
limit: integer
Requested number of resources to be provided in response.
-
offset: integer
Requested index for start of resources to be provided in response.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Headers
-
X-Result-Count:
Actual number of items returned in the response body.
-
X-Total-Count:
Total number of items matching criteria.
Root Schema : schema
Type:
Show Source
array-
Array of:
object SuspendServiceOrderOSM
OSM extension to define the SuspendServiceOrder structure.
Nested Schema : SuspendServiceOrderOSM
Type:
objectOSM 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.
Nested 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
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.
Nested Schema : ServiceOrderRef
Type:
objectService 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.
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
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.
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
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.
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
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.
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
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.
405 Response
Method Not allowed
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
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.
409 Response
Conflict
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
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.
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
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.