REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all service request tags

get

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags

Request

Query Parameters

$fields: string

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
$filter: string

The resource collection will be queried using the specified filter condition.
$limit: integer

Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.

Default Value: 25
$offset: integer

Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.

Default Value: 0
$sortBy: string

Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Response

Default Response

An array of items response

Root Schema : serviceRequestTags_view-default

Match All

Show Source

object __collection_context
object serviceRequestTags_view-default-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceRequestTags_view-default_item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

hasMore: boolean

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : serviceRequestTags_view-default-allOf[1]

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceRequestTags_view-default_item-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: serviceRequestTags_view-default_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceRequestTags_view-default_item-response"
    }
}

Nested Schema : serviceRequestTags_view-default_item-response

Match All

Show Source

allOf serviceRequestTags_item-response
object serviceRequestTags_view-default_item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceRequestTags_item-response"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                },
                "createdBy":{
                },
                "timeCreated":{
                },
                "tag":{
                    "type":"object",
                    "properties":{
                        "id":{
                        },
                        "value":{
                        },
                        "administratorCreatedFlag":{
                        }
                    }
                },
                "serviceRequest":{
                    "type":"object",
                    "properties":{
                        "id":{
                        },
                        "number":{
                        }
                    }
                }
            }
        }
    ]
}

Nested 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 : serviceRequestTags_view-default_item-response-allOf[1]

Type: object

Show Source

createdBy:
id:
serviceRequest: object serviceRequest
tag: object tag
timeCreated:

{
    "type":"object",
    "properties":{
        "id":{
        },
        "createdBy":{
        },
        "timeCreated":{
        },
        "tag":{
            "type":"object",
            "properties":{
                "id":{
                },
                "value":{
                },
                "administratorCreatedFlag":{
                }
            }
        },
        "serviceRequest":{
            "type":"object",
            "properties":{
                "id":{
                },
                "number":{
                }
            }
        }
    }
}

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

Nested Schema : serviceRequest

Type: object

Show Source

id:
number:

{
    "type":"object",
    "properties":{
        "id":{
        },
        "number":{
        }
    }
}

Nested Schema : tag

Type: object

Show Source

administratorCreatedFlag:
id:
value:

{
    "type":"object",
    "properties":{
        "id":{
        },
        "value":{
        },
        "administratorCreatedFlag":{
        }
    }
}

Examples

The following example shows how to get all service request tags 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' \
--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.

{
    "items": [
        {
            "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"
                        }
                    }
                }
            }
        },
        {
            "id": "300100542251149",
            "createdBy": "SALES_ADMIN",
            "timeCreated": "2021-04-28T10:34:25Z",
            "$id": "300100542251149",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequestTags/300100542251149"
                    }
                }
            },
            "tag": {
                "id": "300100542251150",
                "value": "OTBI_Tag4",
                "administratorCreatedFlag": false,
                "$id": "300100542251150",
                "$context": {
                    "etag": "1",
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100542251150"
                        }
                    }
                }
            },
            "serviceRequest": {
                "id": "300100542611205",
                "number": "SR0000052106",
                "$id": "300100542611205",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequests/300100542611205"
                        }
                    }
                }
            }
        },
        {
            "id": "300100572582600",
            "createdBy": "albert.truong@oracle.com",
            "timeCreated": "2023-03-09T16:50:55.147769Z",
            "$id": "300100572582600",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequestTags/300100572582600"
                    }
                }
            },
            "tag": {
                "id": "300100542251150",
                "value": "OTBI_Tag4",
                "administratorCreatedFlag": false,
                "$id": "300100542251150",
                "$context": {
                    "etag": "1",
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100542251150"
                        }
                    }
                }
            },
            "serviceRequest": {
                "id": "300100572592606",
                "number": "SR0000060125",
                "$id": "300100572592606",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequests/300100572592606"
                        }
                    }
                }
            }
        },
        {
            "id": "300100572628643",
            "createdBy": "albert.truong@oracle.com",
            "timeCreated": "2023-03-13T18:45:36.841844Z",
            "$id": "300100572628643",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequestTags/300100572628643"
                    }
                }
            },
            "tag": {
                "id": "300100572628642",
                "value": "EJVN_TEST_3333",
                "administratorCreatedFlag": false,
                "$id": "300100572628642",
                "$context": {
                    "etag": "1",
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100572628642"
                        }
                    }
                }
            },
            "serviceRequest": {
                "id": "300100572624784",
                "number": "SR0000060149",
                "$id": "300100572624784",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequests/300100572624784"
                        }
                    }
                }
            }
        },
        {
            "id": "300100572628645",
            "createdBy": "albert.truong@oracle.com",
            "timeCreated": "2023-03-13T18:49:43.826312Z",
            "$id": "300100572628645",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequestTags/300100572628645"
                    }
                }
            },
            "tag": {
                "id": "300100572628644",
                "value": "BOSSTags_57489",
                "administratorCreatedFlag": false,
                "$id": "300100572628644",
                "$context": {
                    "etag": "1",
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100572628644"
                        }
                    }
                }
            },
            "serviceRequest": {
                "id": "300100572627408",
                "number": "SR0000060150",
                "$id": "300100572627408",
                "$context": {
                    "links": {
                        "$self": {
                            "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1:17/serviceRequests/300100572627408"
                        }
                    }
                }
            }
        }
    ],
    "hasMore": true
}