Jump to

• Request
• Response

Get all participants

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationSearchPayees

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 participant with the specified primary key.
    Finder Variables
    • ParticipantId; integer; The unique identifier of the participant.
• 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveFlag; boolean; Indicates whether the participant is active or not.
  • AnalystId; integer; The unique identifier of the analyst assigned to this participant.
  • AnalystName; string; Analyst Name
  • EffectiveEndDate; string; The date and time when the participant becomes inactive.
  • EffectiveStartDate; string; The date and time when the participant becomes active.
  • EmailAddress; string; The email address of the participant.
  • HRPersonNumber; string; The HCM person number for the participant.
  • HRPrimaryWorkerNumber; string; The employee number assigned by human resources.
  • OrgId; integer; The unique identifier of the business unit.
  • ParticipantFirstName; string; The first name of the participant.
  • ParticipantId; integer; The unique identifier for a participant.
  • ParticipantLastName; string; The last name of the participant.
  • ParticipantName; string; The name of the participant in incentive compensation.
  • ParticipantType; string; Indicates whether the participant is an administrator.
  • PartyId; integer; The unique identifier for the party record in the trading community model.
  • PartyNumber; string; The user-defined value of the party associated with the participant.
  • PayeeOnly; string; Indicates if the participant is assigned as a payee to another participant's plan, and doesn't have his own plan. The default value is true.
  • PersonId; integer; The system generated unique identifier for the HR person, which was imported as a participant.
  • PersonNumber; string; The HCM person number for the participant.
  • SourceSystem; string; The system from which the participant was imported.
  • SourceSystemId; string; The unique identifier for the source system from which the participant was imported.
  • StartDate; string; The participant start date that governs assignment start date.
  • UserGUID; string; The unique user identifier associated with the participant.
• 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: 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.

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

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.
• items: array Items
  Title: Items

  The items in the collection.
• 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."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationSearchPayees-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationSearchPayees-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationSearchPayees-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 : incentiveCompensationSearchPayees-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the participant is active or not.
• AnalystId: integer (int64)
  Read Only: true

  The unique identifier of the analyst assigned to this participant.
• AnalystName: string
  Read Only: true

  Maximum Length: 360

  Analyst Name
• EffectiveEndDate: string (date)
  Read Only: true

  The date and time when the participant becomes inactive.
• EffectiveStartDate: string (date)
  Read Only: true

  The date and time when the participant becomes active.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the participant.
• HRPersonNumber: string
  Read Only: true

  Maximum Length: 30

  The HCM person number for the participant.
• HRPrimaryWorkerNumber: string
  Read Only: true

  Maximum Length: 30

  The employee number assigned by human resources.
• 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.
• ParticipantFirstName: string
  Read Only: true

  Maximum Length: 150

  The first name of the participant.
• ParticipantId: integer (int64)
  Read Only: true

  The unique identifier for a participant.
• ParticipantLastName: string
  Read Only: true

  Maximum Length: 150

  The last name of the participant.
• ParticipantName: string
  Read Only: true

  Maximum Length: 360

  The name of the participant in incentive compensation.
• ParticipantType: string
  Read Only: true

  Maximum Length: 60

  Indicates whether the participant is an administrator.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier for the party record in the trading community model.
• PartyNumber: string
  Read Only: true

  Maximum Length: 30

  The user-defined value of the party associated with the participant.
• PayeeOnly: string
  Read Only: true

  Maximum Length: 1

  Indicates if the participant is assigned as a payee to another participant's plan, and doesn't have his own plan. The default value is true.
• PersonId: integer (int64)
  Read Only: true

  The system generated unique identifier for the HR person, which was imported as a participant.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  The HCM person number for the participant.
• SourceSystem: string
  Read Only: true

  Maximum Length: 60

  The system from which the participant was imported.
• SourceSystemId: string
  Read Only: true

  Maximum Length: 60

  The unique identifier for the source system from which the participant was imported.
• StartDate: string (date)
  Read Only: true

  The participant start date that governs assignment start date.
• UserGUID: string
  Read Only: true

  Maximum Length: 64

  The unique user identifier associated with the participant.

{
    "type":"object",
    "properties":{
        "HRPrimaryWorkerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The employee number assigned by human resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The HCM person number for the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeOnly":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the participant is assigned as a payee to another participant's plan, and doesn't have his own plan. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date and time when the participant becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserGUID":{
            "maxLength":64,
            "type":"string",
            "description":"The unique user identifier associated with the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant in incentive compensation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the source system from which the participant was imported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the participant is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystName":{
            "maxLength":360,
            "type":"string",
            "description":"Analyst Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The participant start date that governs assignment start date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The user-defined value of the party associated with the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party record in the trading community model.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The system generated unique identifier for the HR person, which was imported as a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AnalystId":{
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to this participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "maxLength":60,
            "type":"string",
            "description":"Indicates whether the participant is an administrator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":60,
            "type":"string",
            "description":"The system from which the participant was imported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date and time when the participant becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HRPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The HCM person number for the participant.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top