Jump to

• Request
• Response
• Examples

Get a tag instance

get

/api/boss/data/objects/ora/cxServiceCore/common/v1/tags/{tags_id}

Request

Path Parameters

• tags_id(required): string
  This path parameter maps to the following field defined in the Tags REST resource:
  

  1. value: The name of the tag.

Query Parameters

• $effectiveDate: string(date)
  Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

There's no request body for this operation.

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : tags_item-response

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.
• object __busObj_context

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

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

Links

$self

Parameters:

• tags_id: $request.path.tags_id

Back to Top

Examples

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

cURL Command

curl -X GET --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServieCore/common/vi/tags/BOSS_CREATETAG' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>

Example of Response Body

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

{
    "id": "300100572685592",
    "value": "BOSS_CREATETAG",
    "administratorCreatedFlag": false,
    "createdBy": "[e-mail]",
    "timeCreated": "2023-03-19T21:01:18.82022Z",
    "$id": "300100572685592",
    "$context": {
        "etag": "1",
        "links": {
            "$self": {
                "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100572685592"
            }
        }
    }
}

Back to Top