REST API Reference for Billing Care

Update a Sharing Group

put

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

Updates the specified charge sharing group or discount sharing group or product sharing group.

Both the id parameter and type query parameter are required.

Request

Path Parameters

id(required): string

The ID of the sharing group.

Query Parameters

type: string

The type of sharing group: charge, discount, product, or profile.
This query parameter is required.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

accountRef: object ResourceRef
extension: object extension

The extended attributes.
groupName(required): string

The name of the sharing group.
groupOwnerBalGroupref: object ResourceRef
ownership: array ownership

The list of owners for the sharing group.
parentRef: object ResourceRef

{
    "required":[
        "groupName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "groupName":{
            "type":"string",
            "description":"The name of the sharing group."
        },
        "groupOwnerBalGroupref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "ownership":{
            "type":"array",
            "description":"The list of owners for the sharing group.",
            "items":{
                "$ref":"#/components/schemas/Ownership"
            }
        }
    },
    "xml":{
        "name":"sharingOwner"
    }
}

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 : ownership

Type: array

The list of owners for the sharing group.

Show Source

Array of: object Ownership

The list of owners for the sharing group.

{
    "type":"array",
    "description":"The list of owners for the sharing group.",
    "items":{
        "$ref":"#/components/schemas/Ownership"
    }
}

Nested Schema : Ownership

Type: object

The list of owners for the sharing group.

Show Source

index: integer (int32)

The position of the entry in the index. For example, the first item in a list would have an index value of 1.
markAsDelete: boolean

Whether to delete the ownership (true) or not (false).
offeringRef: object ResourceRef
sharingRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "sharingRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offeringRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "markAsDelete":{
            "type":"boolean",
            "description":"Whether to delete the ownership (<b>true</b>) or not (<b>false</b>)."
        },
        "index":{
            "type":"integer",
            "description":"The position of the entry in the index. For example, the first item in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        }
    },
    "description":"The list of owners for the sharing group."
}

Root Schema : schema

Type: object

Show Source

accountRef: object ResourceRef
extension: object extension

The extended attributes.
groupName(required): string

The name of the sharing group.
groupOwnerBalGroupref: object ResourceRef
ownership: array ownership

The list of owners for the sharing group.
parentRef: object ResourceRef

{
    "required":[
        "groupName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "groupName":{
            "type":"string",
            "description":"The name of the sharing group."
        },
        "groupOwnerBalGroupref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "ownership":{
            "type":"array",
            "description":"The list of owners for the sharing group.",
            "items":{
                "$ref":"#/components/schemas/Ownership"
            }
        }
    },
    "xml":{
        "name":"sharingOwner"
    }
}

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 : ownership

Type: array

The list of owners for the sharing group.

Show Source

Array of: object Ownership

The list of owners for the sharing group.

{
    "type":"array",
    "description":"The list of owners for the sharing group.",
    "items":{
        "$ref":"#/components/schemas/Ownership"
    }
}

Nested Schema : Ownership

Type: object

The list of owners for the sharing group.

Show Source

index: integer (int32)

The position of the entry in the index. For example, the first item in a list would have an index value of 1.
markAsDelete: boolean

Whether to delete the ownership (true) or not (false).
offeringRef: object ResourceRef
sharingRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "sharingRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offeringRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "markAsDelete":{
            "type":"boolean",
            "description":"Whether to delete the ownership (<b>true</b>) or not (<b>false</b>)."
        },
        "index":{
            "type":"integer",
            "description":"The position of the entry in the index. For example, the first item in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        }
    },
    "description":"The list of owners for the sharing group."
}

Response

201 Response

The sharing group was updated successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Examples

This example shows how to update a product sharing group 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/sharing/0.0.0.1+-group-sharing-products+221231?type=product -H 'content-type: application/json' -d @updateSharingGroup.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.
updateSharingGroup.json is the JSON file that specifies the update to make.

Example of Request Body

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

{
   "groupName": "vpn-sharing-group-update",
   "ownership": [
      {
         "sharingRef": {
            "id": "0.0.0.1+-product+48642",
            "uri": null
         },
         "offeringRef": {
            "id": "0.0.0.1+-purchased_product+154290",
            "uri": null
         },
         "index": -1,
         "markAsDelete":false
      }
   ]
}

Example of Response Body

If successful, the response returns code 200 set to true with no response body.