Jump to

• Request
• Response

Advanced query all set ID reference groups

post

https://<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/setIdReferenceGroups/$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" } } } ] }

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{ "allOf":[ { "$ref":"#/components/schemas/__item_query" }, { "type":"object", "properties":{ "collection":{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false } } } ] }

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
• fields: array fields
• subTypes: object subTypes

{ "type":"object", "properties":{ "fields":{ "type":"array", "items":{ "type":"string" } }, "subTypes":{ "type":"object" }, "accessors":{ "type":"object" } } }

Nested Schema : type

Type: object

Show Source

• collection: object collection

{ "type":"object", "properties":{ "collection":{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false } } }

Nested Schema : type

Type: object

Show Source

• parameters: object parameters

{ "type":"object", "properties":{ "parameters":{ "type":"object" } } }

Nested Schema : accessors

Type: object

Nested Schema : fields

Type: array

Show Source

• Array of: string

{ "type":"array", "items":{ "type":"string" } }

Nested Schema : subTypes

Type: object

Nested Schema : collection

Type: object

Show Source

• filter: string
• limit: integer
• offset: integer
• privilege: string
• sortBy: array sortBy

{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false }

Nested Schema : sortBy

Type: array

Show Source

• Array of: items

{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }

Nested Schema : items

Match One Schema

Show Source

• string
• object type

{ "oneOf":[ { "type":"string" }, { "type":"object" } ] }

Nested Schema : type

Type: object

Nested Schema : parameters

Type: object

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : setIdReferenceGroups_view-default

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: setIdReferenceGroups_view-default_item-response

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

Nested Schema : setIdReferenceGroups_view-default_item-response

Match All

Show Source

• allOf setIdReferenceGroups_item-response
• object setIdReferenceGroups_view-default_item-response-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/setIdReferenceGroups_item-response" }, { "type":"object", "properties":{ "referenceGroupName":{ }, "visibleGroupName":{ }, "description":{ } } } ] }

Nested Schema : setIdReferenceGroups_item-response

Match All

Show Source

• object Set ID Reference Group
  Title: Set ID Reference Group

  The set ID reference groups list of values resource is used to query the set ID reference groups.
• object __busObj_context
• object setIdReferenceGroups_item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdReferenceGroup_item" }, { "$ref":"#/components/schemas/__busObj_context" }, { "type":"object", "properties":{ "$translations":{ "$ref":"#/components/schemas/setIdReferenceGroups-_translations" }, "setIdAssignments":{ "$ref":"#/components/schemas/setIdReferenceGroups-setIdAssignments" } } } ] }

Nested Schema : Set ID Reference Group

Type: object

Title: Set ID Reference Group

The set ID reference groups list of values resource is used to query the set ID reference groups.

Show Source

• $sourceLang: string
  Title: $sourceLang

  Read Only: true
• applicationId: string (big-integer)
  Title: Application ID

  Read Only: true

  The unique identifier of the application.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Reference Group Description

  Read Only: true

  The description of the reference group.
• determinantType: string
  Title: Determinant Type

  Read Only: true

  The unique identifier of the determinant type.
• referenceGroupName: string
  Title: Reference Group Name

  Read Only: true

  The unique identifier of the set ID reference group.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.
• visibleGroupName: string
  Title: Visible Group Name

  Read Only: true

  The translated visible name of the set ID reference group.

{ "type":"object", "properties":{ "referenceGroupName":{ "title":"Reference Group Name", "type":"string", "description":"The unique identifier of the set ID reference group.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "determinantType":{ "title":"Determinant Type", "type":"string", "description":"The unique identifier of the determinant type.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "applicationId":{ "title":"Application ID", "type":"string", "format":"big-integer", "description":"The unique identifier of the application.", "readOnly":true }, "createdBy":{ "title":"Created By", "type":"string", "description":"The user who created the record.", "readOnly":true }, "timeCreated":{ "title":"Created On", "type":"string", "format":"date-time", "description":"The date and time when the record was created.", "readOnly":true }, "updatedBy":{ "title":"Last Updated By", "type":"string", "description":"The user who last updated the record.", "readOnly":true }, "timeUpdated":{ "title":"Last Updated Date", "type":"string", "format":"date-time", "description":"The date and time when the record was last updated.", "readOnly":true }, "visibleGroupName":{ "title":"Visible Group Name", "type":"string", "description":"The translated visible name of the set ID reference group.", "readOnly":true }, "description":{ "title":"Reference Group Description", "type":"string", "description":"The description of the reference group.", "readOnly":true }, "$sourceLang":{ "title":"$sourceLang", "type":"string", "readOnly":true } }, "title":"Set ID Reference Group", "x-hints":{ "titlePlural":"Set ID Reference Groups" }, "description":"The set ID reference groups list of values resource is used to query the set ID reference groups.", "x-primaryKey":[ "referenceGroupName" ] }

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 : setIdReferenceGroups_item-response-allOf[2]

Type: object

Show Source

• $translations: setIdReferenceGroups-_translations
• setIdAssignments: setIdReferenceGroups-setIdAssignments

{ "type":"object", "properties":{ "$translations":{ "$ref":"#/components/schemas/setIdReferenceGroups-_translations" }, "setIdAssignments":{ "$ref":"#/components/schemas/setIdReferenceGroups-setIdAssignments" } } }

Nested Schema : setIdReferenceGroups_view-default_item-response-allOf[1]

Type: object

Show Source

• description:
• referenceGroupName:
• visibleGroupName:

{ "type":"object", "properties":{ "referenceGroupName":{ }, "visibleGroupName":{ }, "description":{ } } }

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 : setIdReferenceGroups-_translations

Match All

Show Source

• object __collection_context
• object setIdReferenceGroups-_translations-allOf[1]

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

Nested Schema : setIdReferenceGroups-setIdAssignments

Match All

Show Source

• object __collection_context
• object setIdReferenceGroups-setIdAssignments-allOf[1]

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

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

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

Nested Schema : setIdReferenceGroups-_translations-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: setIdReferenceGroups-_translations_item-response

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

Nested Schema : setIdReferenceGroups-_translations_item-response

Match All

Show Source

• object oraCommonAppsInfraObjects.SetIdReferenceGroupTranslation_item
  The translation of the set ID reference group list of values resource.
• object __busObj_context

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

Nested Schema : oraCommonAppsInfraObjects.SetIdReferenceGroupTranslation_item

Type: object

The translation of the set ID reference group list of values resource.

Show Source

• $language: string
  Read Only: true
• $sourceLang: string
  Read Only: true
• referenceGroupName: string
  Read Only: true

  The unique identifier of the set ID reference group.
• setIdReferenceGroup: setIdReferenceGroup

{ "type":"object", "properties":{ "referenceGroupName":{ "type":"string", "description":"The unique identifier of the set ID reference group.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$language":{ "type":"string", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "setIdReferenceGroup":{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdReferenceGroup_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] } }, "description":"The translation of the set ID reference group list of values resource.", "x-primaryKey":[ "referenceGroupName", "$language" ] }

Nested Schema : setIdReferenceGroup

Match All

Show Source

• object Set ID Reference Group
  Title: Set ID Reference Group

  The set ID reference groups list of values resource is used to query the set ID reference groups.
• object __busObj_context

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

Nested Schema : setIdReferenceGroups-setIdAssignments-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: setIdReferenceGroups-setIdAssignments_item-response

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

Nested Schema : setIdReferenceGroups-setIdAssignments_item-response

Match All

Show Source

• object Set ID Assignment
  Title: Set ID Assignment

  The set ID assignment list of values resource.
• object __busObj_context

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

Nested Schema : Set ID Assignment

Type: object

Title: Set ID Assignment

The set ID assignment list of values resource.

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• determinantType: determinantType
• determinantValue: string (big-integer)
  Title: Determinant Value

  Read Only: true

  The set ID assignment determinant value.
• referenceGroup: referenceGroup
• referenceGroupName: string
  Title: Reference Group Name

  Read Only: true

  The unique identifier of the set ID reference group.
• setIdSet: setIdSet
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{ "type":"object", "properties":{ "referenceGroupName":{ "title":"Reference Group Name", "type":"string", "description":"The unique identifier of the set ID reference group.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "determinantType":{ "allOf":[ { "title":"Determinant Type", "type":"string", "description":"The unique identifier of the determinant type.", "x-searchable":true, "x-sortable":true, "readOnly":true }, { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.DeterminantType_enum" } ] }, "determinantValue":{ "title":"Determinant Value", "type":"string", "format":"big-integer", "description":"The set ID assignment determinant value.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "createdBy":{ "title":"Created By", "type":"string", "description":"The user who created the record.", "readOnly":true }, "timeCreated":{ "title":"Created On", "type":"string", "format":"date-time", "description":"The date and time when the record was created.", "readOnly":true }, "updatedBy":{ "title":"Last Updated By", "type":"string", "description":"The user who last updated the record.", "readOnly":true }, "timeUpdated":{ "title":"Last Updated Date", "type":"string", "format":"date-time", "description":"The date and time when the record was last updated.", "readOnly":true }, "setIdSet":{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdSet_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] }, "referenceGroup":{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.SetIdReferenceGroup_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] } }, "title":"Set ID Assignment", "x-hints":{ "titlePlural":"Set ID Assignments" }, "description":"The set ID assignment list of values resource.", "x-primaryKey":[ "determinantType", "referenceGroupName", "determinantValue" ] }

Nested Schema : determinantType

Match All

The unique identifier of the determinant type.

Show Source

• string
  Title: Determinant Type

  Read Only: true

  The unique identifier of the determinant type.
• string
  Allowed Values: [ "AB", "BU", "CST", "PU", "SET" ]

{ "allOf":[ { "title":"Determinant Type", "type":"string", "description":"The unique identifier of the determinant type.", "x-searchable":true, "x-sortable":true, "readOnly":true }, { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.DeterminantType_enum" } ] }

Nested Schema : referenceGroup

Match All

Show Source

• object Set ID Reference Group
  Title: Set ID Reference Group

  The set ID reference groups list of values resource is used to query the set ID reference groups.
• object __busObj_context

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

Nested Schema : setIdSet

Match All

Show Source

• object Set ID Set
  Title: Set ID Set

  The set ID sets list of values resource is used to query the set ID sets.
• object __busObj_context

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

Nested Schema : Set ID Set

Type: object

Title: Set ID Set

The set ID sets list of values resource is used to query the set ID sets.

Show Source

• $sourceLang: string
  Read Only: true
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Set Description

  Read Only: true

  The description of the set ID set.
• setCode: string
  Title: Set Code

  Read Only: true

  The unique code that identifies the set ID set.
• setId: string (big-integer)
  Title: Set ID

  Read Only: true

  The unique identifier of the set ID set.
• setName: string
  Title: Set Name

  Read Only: true

  The descriptive name of the Set ID Set.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{ "type":"object", "properties":{ "setId":{ "title":"Set ID", "type":"string", "format":"big-integer", "description":"The unique identifier of the set ID set.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "setCode":{ "title":"Set Code", "type":"string", "description":"The unique code that identifies the set ID set.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "createdBy":{ "title":"Created By", "type":"string", "description":"The user who created the record.", "readOnly":true }, "timeCreated":{ "title":"Created On", "type":"string", "format":"date-time", "description":"The date and time when the record was created.", "readOnly":true }, "updatedBy":{ "title":"Last Updated By", "type":"string", "description":"The user who last updated the record.", "readOnly":true }, "timeUpdated":{ "title":"Last Updated Date", "type":"string", "format":"date-time", "description":"The date and time when the record was last updated.", "readOnly":true }, "description":{ "title":"Set Description", "type":"string", "description":"The description of the set ID set.", "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "setName":{ "title":"Set Name", "type":"string", "description":"The descriptive name of the Set ID Set.", "readOnly":true } }, "title":"Set ID Set", "x-hints":{ "titlePlural":"Set ID Sets" }, "description":"The set ID sets list of values resource is used to query the set ID sets.", "x-primaryKey":[ "setId" ] }

Back to Top