Jump to

• Request
• Response
• Examples

Get a service request tag

get

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags/{serviceRequestTags_id}

Request

Path Parameters

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

  1. id: The unique identifier of the tag's association with the object.

Query Parameters

• $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 : serviceRequestTags_item-response

Match All

Show Source

• allOf oraCxServiceCoreSrMgmt.ServiceRequestTag_item
• object __busObj_context

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

Nested Schema : oraCxServiceCoreSrMgmt.ServiceRequestTag_item

Match All

Show Source

• object Service Request Tag
  Title: Service Request Tag

  Service request tags are keywords or terms assigned to a service request that help in describing and classifying the service request.
• object oraCxServiceCoreCommon.ObjectTag_abstract-item
• object oraCxServiceCoreSrMgmt.ServiceRequestTag_item-allOf[2]

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "serviceRequest":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.ServiceRequest_item"
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        }
                    ]
                }
            },
            "title":"Service Request Tag",
            "x-hints":{
                "titlePlural":"Service Request Tags"
            },
            "description":"Service request tags are keywords or terms assigned to a service request that help in describing and classifying the service request."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ObjectTag_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "title":"Tag Reference ID",
                    "description":"The unique identifier of the tag's association with the object.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : Service Request Tag

Type: object

Title: Service Request Tag

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

Show Source

• serviceRequest: serviceRequest

{
    "type":"object",
    "properties":{
        "serviceRequest":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreSrMgmt.ServiceRequest_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "title":"Service Request Tag",
    "x-hints":{
        "titlePlural":"Service Request Tags"
    },
    "description":"Service request tags are keywords or terms assigned to a service request that help in describing and classifying the service request."
}

Nested Schema : oraCxServiceCoreCommon.ObjectTag_abstract-item

Type: object

Show Source

• createdBy: string
  Read Only: true
• id: string (big-integer)
  Read Only: true
• tag: tag
• timeCreated: string (date-time)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "tag":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreCommon.Tag_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ]
}

Nested Schema : oraCxServiceCoreSrMgmt.ServiceRequestTag_item-allOf[2]

Type: object

Show Source

• createdBy: string
  Title: Created By

  The user who created the record.
• id: string
  Title: Tag Reference ID

  The unique identifier of the tag's association with the object.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Tag Reference ID",
            "description":"The unique identifier of the tag's association with the object.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        }
    }
}

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

Match All

Show Source

• object Service Request
  Title: Service Request

  A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.
• object __busObj_context

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

Nested Schema : Service Request

Type: object

Title: Service Request

A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved.

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

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

  Read Only: true

  The unique identifier of the service request record.
• number: string
  Title: Reference Number

  Read Only: true

  The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Service Request ID",
            "description":"The unique identifier of the service request record."
        },
        "number":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Reference Number",
            "description":"The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        }
    },
    "x-primaryKey":[
        "id"
    ],
    "x-alternateKeys":{
        "srNumberAltKey":[
            "number"
        ]
    },
    "title":"Service Request",
    "x-hints":{
        "titlePlural":"Service Requests"
    },
    "description":"A service request is a document to track a request from a worker for a service from the time the worker makes the request until the request is resolved."
}

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

Nested Schema : tag

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

Links

$self

Parameters:

• serviceRequestTags_id: $request.path.serviceRequestTags_id

tag

Parameters:

• tags_id: $response.body#/tag/$id

The tags resource is used to manage tags.

Back to Top

Examples

The following example shows how to get a service request 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/cxServiceCore/srMgmt/v1/serviceRequestTags/300100542250072' \
--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": "300100542250072",
    "createdBy": "SALES_ADMIN",
    "timeCreated": "2021-04-28T10:32:20Z",
    "$id": "300100542250072",
    "$context": {
        "etag": "1",
        "links": {
            "$self": {
                "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequestTags/300100542250072"
            }
        }
    },
    "tag": {
        "id": "300100542250073",
        "value": "OTBI_Tag1",
        "administratorCreatedFlag": false,
        "$id": "300100542250073",
        "$context": {
            "etag": "1",
            "links": {
                "$self": {
                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100542250073"
                }
            }
        }
    },
    "serviceRequest": {
        "id": "300100542611201",
        "number": "SR0000052105",
        "$id": "300100542611201",
        "$context": {
            "links": {
                "$self": {
                    "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequests/300100542611201"
                }
            }
        }
    }
}

Back to Top