Jump to

• Request
• Response

Get all set ID set assignments

get

http://servername/fscmRestApi/resources/11.13.18.05/setIdAssignmentsSet

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:
  
  

  • AssignmentFinder :Finds the set ID assignment set for the given assignment.
    Finder Variables:
    • DeterminantValue :The unique determinant value that identifies the set ID assignment set.
    • ReferenceGroupName :The unique identifier of the set ID reference group.
  • DeterminantFinder :Finds all of the set ID assignments for the given set ID code.
    Finder Variables:
    • bindDeterminantSetCode :The unique identifier of the assignment set.
  • PrimaryKey :Finds the set ID assignment for the given primary key.
    Finder Variables:
    • DeterminantType :The unique identifier of the determinant type.
    • DeterminantValue :The unique identifier of the determinant value.
    • ReferenceGroupName :The unique identifier of the set ID reference group.
  • ReferenceGroupFinder :Finds all of the set ID assignments asset books for the given reference group name.
    Finder Variables:
    • bindReferenceGroupName :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 : setIdAssignmentsSet

Match All

Show Source

• object CollectionProperties
• object setIdAssignmentsSet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CollectionProperties"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/setIdAssignmentsSet-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionProperties

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : setIdAssignmentsSet-allOf[1]

Type: object

Show Source

• items: array Items
  Title: Items

  The items in the collection.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/setIdAssignmentsSet-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance. Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action"
            ]
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: setIdAssignmentsSet-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/setIdAssignmentsSet-item-response"
    }
}

Nested Schema : setIdAssignmentsSet-item-response

Match All

Show Source

• object ItemProperties
• object Set ID Assignments Set VO
  Title: Set ID Assignments Set VO

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setIdAssignmentsSet-item"
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Set ID Assignments Set VO

Type: object

Title: Set ID Assignments Set VO

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DeterminantCode: string
  Title: Set Code

  Maximum Length: 30

  The unique identifier of the determinant code.
• DeterminantType: string
  Maximum Length: 30

  The unique identifier of the determinant type.
• DeterminantValue: integer (int64)
  Title: Determinant Value

  The unique identifier of the determinant value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login credentials of the person who last updated the record.
• ReferenceGroupName: string
  Title: Reference Group Name

  Maximum Length: 30

  The unique identifier of the set ID reference group.
• SetCode: string
  Title: Set Code

  Maximum Length: 30

  The unique code that identifies the set ID set.
• SetId: integer (int64)
  The unique identifier of the set ID set.

{
    "title":"Set ID Assignments Set VO",
    "type":"object",
    "properties":{
        "DeterminantType":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the determinant type.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ReferenceGroupName":{
            "title":"Reference Group Name",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the set ID reference group.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "DeterminantValue":{
            "title":"Determinant Value",
            "type":"integer",
            "description":"The unique identifier of the determinant value.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":"15"
            }
        },
        "SetId":{
            "type":"integer",
            "description":"The unique identifier of the set ID set.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":"18"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login credentials of the person who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "DeterminantCode":{
            "title":"Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the determinant code.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"choice"
            }
        },
        "SetCode":{
            "title":"Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code that identifies the set ID set.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"choice"
            }
        }
    },
    "x-hints":{
        "titlePlural":"Set ID Assignments for Sets"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top