Jump to

• Request
• Response

Create a pay group role

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles

Request

Path Parameters

• PayGroupId(required): integer(int64)
  The unique identifier of the pay group.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.
• PayGroupId: integer (int64)
  The unique identifier of the pay group.
• RoleId: integer (int64)
  Title: Name

  The unique identifier of a pay group role.
• RolePayGroupId: integer (int64)
  The unique identifier of the role associated with a pay group.
• StartDate: string (date)
  Title: Start Date

  The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.",
            "format":"date",
            "nullable":false
        },
        "RolePayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a pay group role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.",
            "format":"date",
            "nullable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : incentiveCompensationPayGroups-PayGroupRoles-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the pay group role assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the pay group role assignment is created.
• EndDate: string (date)
  Title: End Date

  The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the pay group role assignment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the pay group role assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayGroupId: integer (int64)
  The unique identifier of the pay group.
• RoleDescription: string
  Title: Role Description

  Read Only: true

  Maximum Length: 120

  A brief description of the pay group role.
• RoleId: integer (int64)
  Title: Name

  The unique identifier of a pay group role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the pay group role.
• RolePayGroupId: integer (int64)
  The unique identifier of the role associated with a pay group.
• StartDate: string (date)
  Title: Start Date

  The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the pay group role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolePayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":"120",
            "type":"string",
            "description":"A brief description of the pay group role.",
            "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"
            }
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a pay group role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment was last updated.",
            "format":"date-time",
            "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

RoleVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles

The list of values containing the unique identifiers of the incentive compensation roles.

The following properties are defined on the LOV link relation:

• Source Attribute: RoleId; Target Attribute: RoleId
• Display Attribute: RoleName, RoleId, AccessType

Back to Top