Jump to

• Request
• Response
• Examples

Create a tag instance

post

/api/boss/data/objects/ora/cxServiceCore/common/v1/tags

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf oraCxServiceCoreCommon.Tag_post-item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.Tag_post-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxServiceCoreCommon.Tag_post-item

Match All

Show Source

• object Tag
  Title: Tag

  Service request tags are used to manage keywords or terms assigned to a service request. Service request tags help in describing and classifying a service request.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.Tag_item"
        }
    ],
    "required":[
        "value"
    ]
}

Nested Schema : Tag

Type: object

Title: Tag

Service request tags are used to manage keywords or terms assigned to a service request. Service request tags help in describing and classifying a service request.

Show Source

• administratorCreatedFlag: boolean
  Title: Administrator Created

  An indicator to denote that an administrator created the tag.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• id: string (big-integer)
  Title: Tag Value ID

  Read Only: true

  The unique identifier of the tag.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• value: string
  Title: Tag

  The name of the tag.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Tag Value ID",
            "description":"The unique identifier of the tag."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "value":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Tag",
            "description":"The name of the tag."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "administratorCreatedFlag":{
            "type":"boolean",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Administrator Created",
            "description":"An indicator to denote that an administrator created the tag."
        }
    },
    "x-primaryKey":[
        "id"
    ],
    "x-alternateKeys":{
        "tagValueAltKey":[
            "value"
        ]
    },
    "title":"Tag",
    "x-hints":{
        "titlePlural":"Tags"
    },
    "description":"Service request tags are used to manage keywords or terms assigned to a service request. Service request tags help in describing and classifying a service request."
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Default Response

no content

Back to Top

Examples

The following example shows how to create tag by submitting a POST request on the REST resource.

cURL Command

curl -X POST --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServieCore/common/v1/tags/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"value": "BOSS_CREATETAG",
"administratorCreatedFlag": false
}'

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"value": "BOSS_CREATETAG",
"administratorCreatedFlag": false
}

Response: 201 Created

Back to Top