Jump to

• Request
• Response

Get all set ID reference groups

get

http://servername/fscmRestApi/resources/11.13.18.05/setIdReferenceGroups

get

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey :Finds the set ID reference group for the given primary key.
    Finder Variables:
    • ReferenceGroupName :The unique identifier of the set ID reference group.
  • ReferenceGroupNameFinder :Finds all of the set ID assignments asset books for the given reference group name.
    Finder Variables:
    • ReferenceGroupName :The unique identifier of the set ID reference group.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : setIdReferenceGroups

Match All

Show Source

• object __collection_context
• object setIdReferenceGroups-allOf[1]

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

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

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

Nested Schema : setIdReferenceGroups-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: setIdReferenceGroups_item-response

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

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

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