Jump to

• Request
• Response

Update a single configuration

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedTableConfigurations/{incentiveCompensationSummarizedTableConfigurationsUniqID}

Request

Path Parameters

• incentiveCompensationSummarizedTableConfigurationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Incentive Compensation Summarized Table Configurations resource and used to uniquely identify an instance of Incentive Compensation Summarized Table Configurations. The client should not generate the hash key value. Instead, the client should query on the Incentive Compensation Summarized Table Configurations collection resource in order to navigate to a specific instance of Incentive Compensation Summarized Table Configurations to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DataAggrFunction: string
  Maximum Length: 30

  The aggregation function to be used on the specified measure.
• DataColumn: string
  Maximum Length: 30

  The attribute column to be included in the configuration.
• DataColumnType: string
  Maximum Length: 30

  The data type of the attribute column to be included in the configuration.
• ObjectTable: string
  Maximum Length: 30

  The source object from which the attribute is being retrieved for summarization.
• RecordType: string
  Maximum Length: 30

  The type of the record to be included in the summarized table. This will determine if the attribute is included as a dimension or a measure.

{
    "type":"object",
    "properties":{
        "DataColumn":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute column to be included in the configuration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DataColumnSourceLov"
                ]
            }
        },
        "DataColumnType":{
            "maxLength":30,
            "type":"string",
            "description":"The data type of the attribute column to be included in the configuration.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DataColumnSourceLov"
                ]
            }
        },
        "ObjectTable":{
            "maxLength":30,
            "type":"string",
            "description":"The source object from which the attribute is being retrieved for summarization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecordType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the record to be included in the summarized table. This will determine if the attribute is included as a dimension or a measure.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DataAggrFunction":{
            "maxLength":30,
            "type":"string",
            "description":"The aggregation function to be used on the specified measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : incentiveCompensationSummarizedTableConfigurations-item-response

Type: object

Show Source

• BusinessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit.
• DataAggrFunction: string
  Maximum Length: 30

  The aggregation function to be used on the specified measure.
• DataColumn: string
  Maximum Length: 30

  The attribute column to be included in the configuration.
• DataColumnType: string
  Maximum Length: 30

  The data type of the attribute column to be included in the configuration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectTable: string
  Maximum Length: 30

  The source object from which the attribute is being retrieved for summarization.
• ObjectType: string
  Maximum Length: 30

  The type of source object attribute that's being retrieved for summarization.
• ObjectTypeDescription: string
  Read Only: true

  Maximum Length: 80

  The description of the source object attribute.
• OrgId: integer (int64)
  The identifier of the business unit.
• RecordType: string
  Maximum Length: 30

  The type of the record to be included in the summarized table. This will determine if the attribute is included as a dimension or a measure.
• RecordTypeDescription: string
  Read Only: true

  Maximum Length: 80

  The description of the record type.
• ReportConfigId: integer
  The unique system generated identifier of the summarized table configuration.

{
    "type":"object",
    "properties":{
        "OrgId":{
            "type":"integer",
            "description":"The identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of source object attribute that's being retrieved for summarization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataColumnType":{
            "maxLength":30,
            "type":"string",
            "description":"The data type of the attribute column to be included in the configuration.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DataColumnSourceLov"
                ]
            },
            "x-queryable":true
        },
        "ObjectTypeDescription":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the source object attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the record to be included in the summarized table. This will determine if the attribute is included as a dimension or a measure.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataAggrFunction":{
            "maxLength":30,
            "type":"string",
            "description":"The aggregation function to be used on the specified measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataColumn":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute column to be included in the configuration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DataColumnSourceLov"
                ]
            },
            "x-queryable":true
        },
        "RecordTypeDescription":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectTable":{
            "maxLength":30,
            "type":"string",
            "description":"The source object from which the attribute is being retrieved for summarization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportConfigId":{
            "type":"integer",
            "description":"The unique system generated identifier of the summarized table configuration.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top