REST API Reference for Billing Care

Create a Profile

post

/bcws/webresources/v1.0/profiles

Creates the specified profile.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

The profile to create.

Root Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

accountObj: object ResourceRef
creationDate: string (date-time)

The date and time the profile was created.
effectiveDate: string (date-time)

The date and time the profile is effective from.
extension: object extension

The extended attributes.
id: object ResourceRef
multiValued: boolean

Whether the profile has multiple values (true) or not (false).
name: string

The name of the profile.
parentName: string

The name of the parent profile.
selected: boolean

Whether the profile is selected (true) or not (false).
serviceObj: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

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.

The profile to create.

Root Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

accountObj: object ResourceRef
creationDate: string (date-time)

The date and time the profile was created.
effectiveDate: string (date-time)

The date and time the profile is effective from.
extension: object extension

The extended attributes.
id: object ResourceRef
multiValued: boolean

Whether the profile has multiple values (true) or not (false).
name: string

The name of the profile.
parentName: string

The name of the parent profile.
selected: boolean

Whether the profile is selected (true) or not (false).
serviceObj: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

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

201 Response

The profile was created successfully.

Root Schema : resource

Type: object

Show Source

extension: object extension

The extended attributes.
reference(required): object ResourceRef

{
    "required":[
        "reference"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "reference":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"resource"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

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

500 Response

An internal server error occurred.

Examples

This example shows how to create an account profile by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/profiles' -H 'content-type: application/json' -d @createProfile.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.
createProfile.json is the JSON file that specifies the details of the profile.

Example of Request Body

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

{
    "@class": "com.oracle.communications.brm.cc.model.ProfileServExtrating",      
    "id": {
        "id": "0.0.0.1+-profile-serv_extrating+233232",
        "uri": null
    },
    "accountObj": {
        "id": "0.0.0.1+-account+65205",
        "uri": null
    },
    "serviceObj": {
        "id": "0.0.0.1+-service-ip+63861",
        "uri": null
    },
    "name": "HOME_REGION",
    "selected": false,
    "dataArray": [
        {
            "name": "Validity Range 1",
            "validTo": "1610455414000",
            "validFrom": "1609850614000",
            "value": "1234"
        },
        {
            "name": "Validity Range 2",
            "validTo": "1610455414000",
            "validFrom": "1609850614000",
            "value": "123456"
        }
    ],
    "extrating": {
        "label": "Official",
        "referenceCount": 1,
        "status": 3
    }
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "reference": { 
        "id": "0.0.0.1+-profile-serv_extrating+217925",
        "uri": "http://hostname:port/bcws/webresources/v1.0/profiles/0.0.0.1+-profile-serv_extrating+217925"
    }
}