Jump to

• Request
• Response

Advanced query all service request tags

post

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

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 schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_query"
        },
        {
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"object",
                    "description":"Values to be applied in a parameterized filter specific to the view."
                }
            }
        }
    ]
}

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "description":"Defines query criteria that can be applied on a resource collection.",
                    "properties":{
                        "filter":{
                            "type":"string",
                            "description":"The resource collection will be queried using the specified filter condition."
                        },
                        "limit":{
                            "type":"integer",
                            "description":"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."
                        },
                        "offset":{
                            "type":"integer",
                            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                        },
                        "sortBy":{
                            "type":"array",
                            "description":"Orders a resource collection based on the specified fields.",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string",
                                        "description":"Name of field based on which sorting will happen. Order is ascending."
                                    },
                                    {
                                        "type":"object",
                                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string",
                            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
  Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
• fields: array fields
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• subTypes: object subTypes
  Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• collection: object collection
  Defines query criteria that can be applied on a resource collection.

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "description":"Defines query criteria that can be applied on a resource collection.",
            "properties":{
                "filter":{
                    "type":"string",
                    "description":"The resource collection will be queried using the specified filter condition."
                },
                "limit":{
                    "type":"integer",
                    "description":"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."
                },
                "offset":{
                    "type":"integer",
                    "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                },
                "sortBy":{
                    "type":"array",
                    "description":"Orders a resource collection based on the specified fields.",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string",
                                "description":"Name of field based on which sorting will happen. Order is ascending."
                            },
                            {
                                "type":"object",
                                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string",
                    "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                }
            },
            "additionalProperties":false
        }
    }
}

Nested Schema : type

Type: object

Show Source

• parameters: object parameters
  Values to be applied in a parameterized filter specific to the view.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "description":"Values to be applied in a parameterized filter specific to the view."
        }
    }
}

Nested Schema : accessors

Type: object

Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.

Nested Schema : fields

Type: array

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

Nested Schema : collection

Type: object

Defines query criteria that can be applied on a resource collection.

Show Source

• 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.
• offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
• privilege: string
  Represents the privilege or action required to check for while serving a request to access a resource.
• sortBy: array sortBy
  Orders a resource collection based on the specified fields.

{
    "type":"object",
    "description":"Defines query criteria that can be applied on a resource collection.",
    "properties":{
        "filter":{
            "type":"string",
            "description":"The resource collection will be queried using the specified filter condition."
        },
        "limit":{
            "type":"integer",
            "description":"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."
        },
        "offset":{
            "type":"integer",
            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
        },
        "sortBy":{
            "type":"array",
            "description":"Orders a resource collection based on the specified fields.",
            "items":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"Name of field based on which sorting will happen. Order is ascending."
                    },
                    {
                        "type":"object",
                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                    }
                ]
            }
        },
        "privilege":{
            "type":"string",
            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
        }
    },
    "additionalProperties":false
}

Nested Schema : sortBy

Type: array

Orders a resource collection based on the specified fields.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Orders a resource collection based on the specified fields.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"Name of field based on which sorting will happen. Order is ascending."
            },
            {
                "type":"object",
                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• string
  Name of field based on which sorting will happen. Order is ascending.
• object type
  Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

{
    "oneOf":[
        {
            "type":"string",
            "description":"Name of field based on which sorting will happen. Order is ascending."
        },
        {
            "type":"object",
            "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
        }
    ]
}

Nested Schema : type

Type: object

Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

Nested Schema : parameters

Type: object

Values to be applied in a parameterized filter specific to the view.

Back to Top

Response

Default Response

An array of items response

Body ()

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

Back to Top