REST API Reference for Billing Care

Modify a Deferred Action

put

/bcws/webresources/v1.0/deferredactions/{id}

Modifies the specified deferred action.

Request

Path Parameters

id(required): string

The ID of the deferred action, such as 0.0.0.1+-schedule+123123.

Supported Media Types

application/xml
application/json

Details about the deferred action.

Root Schema : schema

Type: object

Show Source

actionId(required): object ResourceRef
actionName(required): string

The action's name.
actionStatus: integer (int32)
The status of the deferred action. Possible values are:
- 0: Pending
- 1: Done
- 2: Error
- 3: Pending and undeletable
description: string

The deferred action's description.
extension: object extension

The extended attributes.
isCollectionsAction: boolean

Whether the deferred action is for collections (true) or not (false).
scheduledDate(required): string (date-time)

The date and time the deferred action is scheduled to occur.
serviceId: object ResourceRef
serviceLogin: string

The service login information.
serviceType: string

The type of the service associated with the action.

{
    "required":[
        "actionId",
        "actionName",
        "scheduledDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "actionName":{
            "type":"string",
            "description":"The action's name."
        },
        "serviceId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceType":{
            "type":"string",
            "description":"The type of the service associated with the action."
        },
        "scheduledDate":{
            "type":"string",
            "description":"The date and time the deferred action is scheduled to occur.",
            "format":"date-time"
        },
        "serviceLogin":{
            "type":"string",
            "description":"The service login information."
        },
        "description":{
            "type":"string",
            "description":"The deferred action's description."
        },
        "isCollectionsAction":{
            "type":"boolean",
            "description":"Whether the deferred action is for collections (<b>true</b>) or not (<b>false</b>)."
        },
        "actionStatus":{
            "type":"integer",
            "description":"The status of the deferred action. Possible values are: <ul><li><b>0</b>: Pending</li><li><b>1</b>: Done</li><li><b>2</b>: Error</li><li><b>3</b>: Pending and undeletable</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"deferredAction"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Details about the deferred action.

Root Schema : schema

Type: object

Show Source

actionId(required): object ResourceRef
actionName(required): string

The action's name.
actionStatus: integer (int32)
The status of the deferred action. Possible values are:
- 0: Pending
- 1: Done
- 2: Error
- 3: Pending and undeletable
description: string

The deferred action's description.
extension: object extension

The extended attributes.
isCollectionsAction: boolean

Whether the deferred action is for collections (true) or not (false).
scheduledDate(required): string (date-time)

The date and time the deferred action is scheduled to occur.
serviceId: object ResourceRef
serviceLogin: string

The service login information.
serviceType: string

The type of the service associated with the action.

{
    "required":[
        "actionId",
        "actionName",
        "scheduledDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "actionName":{
            "type":"string",
            "description":"The action's name."
        },
        "serviceId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceType":{
            "type":"string",
            "description":"The type of the service associated with the action."
        },
        "scheduledDate":{
            "type":"string",
            "description":"The date and time the deferred action is scheduled to occur.",
            "format":"date-time"
        },
        "serviceLogin":{
            "type":"string",
            "description":"The service login information."
        },
        "description":{
            "type":"string",
            "description":"The deferred action's description."
        },
        "isCollectionsAction":{
            "type":"boolean",
            "description":"Whether the deferred action is for collections (<b>true</b>) or not (<b>false</b>)."
        },
        "actionStatus":{
            "type":"integer",
            "description":"The status of the deferred action. Possible values are: <ul><li><b>0</b>: Pending</li><li><b>1</b>: Done</li><li><b>2</b>: Error</li><li><b>3</b>: Pending and undeletable</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"deferredAction"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Response

Supported Media Types

application/xml
application/json

200 Response

The deferred action was modified successfully.

Root Schema : schema

Type: object

Show Source

actionId(required): object ResourceRef
actionName(required): string

The action's name.
actionStatus: integer (int32)
The status of the deferred action. Possible values are:
- 0: Pending
- 1: Done
- 2: Error
- 3: Pending and undeletable
description: string

The deferred action's description.
extension: object extension

The extended attributes.
isCollectionsAction: boolean

Whether the deferred action is for collections (true) or not (false).
scheduledDate(required): string (date-time)

The date and time the deferred action is scheduled to occur.
serviceId: object ResourceRef
serviceLogin: string

The service login information.
serviceType: string

The type of the service associated with the action.

{
    "required":[
        "actionId",
        "actionName",
        "scheduledDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "actionName":{
            "type":"string",
            "description":"The action's name."
        },
        "serviceId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceType":{
            "type":"string",
            "description":"The type of the service associated with the action."
        },
        "scheduledDate":{
            "type":"string",
            "description":"The date and time the deferred action is scheduled to occur.",
            "format":"date-time"
        },
        "serviceLogin":{
            "type":"string",
            "description":"The service login information."
        },
        "description":{
            "type":"string",
            "description":"The deferred action's description."
        },
        "isCollectionsAction":{
            "type":"boolean",
            "description":"Whether the deferred action is for collections (<b>true</b>) or not (<b>false</b>)."
        },
        "actionStatus":{
            "type":"integer",
            "description":"The status of the deferred action. Possible values are: <ul><li><b>0</b>: Pending</li><li><b>1</b>: Done</li><li><b>2</b>: Error</li><li><b>3</b>: Pending and undeletable</li></ul>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"deferredAction"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Examples

This example shows how to update the scheduled date of a deferred action by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/deferredactions/0.0.0.1+-schedule+255194' -H 'content-type: application/json' -d @deferredActionUpdate.json

where:

hostname is the URL for the Billing Care REST server.
port is the port for the Billing Care REST server.
version is the version of the API you're using, such as v1.0.
deferredActionUpdate.json is the JSON file that specifies the details to update.

Example of Request Body

This example shows the contents of the deferredActionUpdate.json file sent as the request body.

{
   "scheduledDate":"2021-02-14"
}

Example of Response Body

This example shows the contents of the response body in JSON format. All unchanged parameters appear as null, so only the values for the action ID and the updated parameter are shown.

{
   "extension": null,
   "actionId": {
      "id": "0.0.0.1+-schedule+279774",
      "uri": null
   },
   "actionName": null,
   "serviceId": null,
   "serviceType": null,
   "scheduledDate": 1613241000000,
   "serviceLogin": null,
   "description": null,
   "isCollectionsAction": null,
   "actionStatus": 0
}