Jump to

• Request
• Response

Get a basic attribute group

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}

Request

Path Parameters

• expressionDetailBasicAttributeGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- BasicAttributesGroup and OrgId ---for the Expression Detail Basic Attribute Groups resource and used to uniquely identify an instance of Expression Detail Basic Attribute Groups. The client should not generate the hash key value. Instead, the client should query on the Expression Detail Basic Attribute Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Expression Detail Basic Attribute Groups.
  
  For example: expressionDetailBasicAttributeGroups?q=BasicAttributesGroup=<value1>;OrgId=<value2>
• incentiveCompensationExpressionDetailItemsLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrgId and ExpressionDetailType ---for the Expression Detail Items resource and used to uniquely identify an instance of Expression Detail Items. The client should not generate the hash key value. Instead, the client should query on the Expression Detail Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Expression Detail Items.
  
  For example: incentiveCompensationExpressionDetailItemsLOV?q=OrgId=<value1>;ExpressionDetailType=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-item-response

Type: object

Show Source

• BasicAttributesGroup: string
  Title: Basic Attributes Group

  Read Only: true

  Maximum Length: 30

  The group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
• BasicAttributesGroupCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
• expressionDetailBasicAttributeNames: array Expression Detail Basic Attribute Names
  Title: Expression Detail Basic Attribute Names

  The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.
• ExpressionDetailTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.
• ExpressionType: string
  Title: Expression Type

  Read Only: true

  Maximum Length: 11

  The type of the expression. The default value is Calculation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Read Only: true

  The unique identifier of the business unit.

{
    "type":"object",
    "properties":{
        "BasicAttributesGroupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "expressionDetailBasicAttributeNames":{
            "title":"Expression Detail Basic Attribute Names",
            "type":"array",
            "description":"The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-expressionDetailBasicAttributeNames-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BasicAttributesGroup":{
            "title":"Basic Attributes Group",
            "maxLength":"30",
            "type":"string",
            "description":"The group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionDetailTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionType":{
            "title":"Expression Type",
            "maxLength":"11",
            "type":"string",
            "description":"The type of the expression. The default value is Calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Expression Detail Basic Attribute Names

Type: array

Title: Expression Detail Basic Attribute Names

The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.

Show Source

• Array of: object incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-expressionDetailBasicAttributeNames-item-response

{
    "title":"Expression Detail Basic Attribute Names",
    "type":"array",
    "description":"The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-expressionDetailBasicAttributeNames-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 : incentiveCompensationExpressionDetailItemsLOV-expressionDetailBasicAttributeGroups-expressionDetailBasicAttributeNames-item-response

Type: object

Show Source

• BasicAttributeColumnName: string
  Title: Basic Attribute Column Name

  Read Only: true

  Maximum Length: 30

  The column within the table that the basic attribute refers to.
• BasicAttributeId: integer (int64)
  Read Only: true

  The unique identifier of the basic attribute used in an expression.
• BasicAttributeName: string
  Title: Basic Attribute Name

  Read Only: true

  Maximum Length: 60

  The type or category of the entity used in an expression. A list of accepted values are listed in the meaning column of lookup codes in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.
• BasicAttributesGroupCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.
• BasicAttributeTableName: string
  Title: Basic Attribute Table Name

  Read Only: true

  Maximum Length: 30

  The table name that the basic attribute refers to.
• ExpressionDetailTypeCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.
• ExpressionType: string
  Title: Expression Type

  Read Only: true

  Maximum Length: 11

  The type of the expression. Default value is Calculation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Read Only: true

  The unique identifier of the business unit.

{
    "type":"object",
    "properties":{
        "BasicAttributesGroupCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the group or category of the primary attributes used in an expression. A list of accepted values are listed in the lookup type CN_EXPR_ATTR_MENU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BasicAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the basic attribute used in an expression.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BasicAttributeName":{
            "title":"Basic Attribute Name",
            "maxLength":"60",
            "type":"string",
            "description":"The type or category of the entity used in an expression. A list of accepted values are listed in the meaning column of  lookup codes in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionDetailTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type or category of the entity used in an expression. A list of accepted values are listed in the lookup type ORA_CN_EXPRESSION_DETAIL_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasicAttributeColumnName":{
            "title":"Basic Attribute Column Name",
            "maxLength":"30",
            "type":"string",
            "description":"The column within the table that the basic attribute refers to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpressionType":{
            "title":"Expression Type",
            "maxLength":"11",
            "type":"string",
            "description":"The type of the expression. Default value is Calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasicAttributeTableName":{
            "title":"Basic Attribute Table Name",
            "maxLength":"30",
            "type":"string",
            "description":"The table name that the basic attribute refers to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

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

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "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",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

expressionDetailBasicAttributeNames

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}/child/expressionDetailBasicAttributeNames

Parameters:

• expressionDetailBasicAttributeGroupsUniqID: $request.path.expressionDetailBasicAttributeGroupsUniqID
• incentiveCompensationExpressionDetailItemsLOVUniqID: $request.path.incentiveCompensationExpressionDetailItemsLOVUniqID

The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.

Back to Top