Actions

The ballerinax/sap.successfactors.ecemployeeprofile package exposes the following clients:

Available clients:

Client	Purpose
Client	Manages ecemployeeprofile objects: Background_Community, Background_Courses, Background_Benefitselection, Background_OutsideWorkExperience, Background_Promotability, Background_Fsaelection, Background_Compensation, Background_Memberships…, over the SAP SuccessFactors OData v2 API.

---

Client

You can use these APIs to maintain the general background information of an employee, including education and outside work experiences.

Configuration

ConnectionConfig

Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.

Field	Type	Default	Description
auth	http:CredentialsConfig	Required	Configurations related to client authentication
httpVersion	http:HttpVersion	See default	The HTTP version understood by the client
http1Settings	http:ClientHttp1Settings	See default	Configurations related to HTTP/1.x protocol
http2Settings	http:ClientHttp2Settings	See default	Configurations related to HTTP/2 protocol
timeout	decimal	See default	The maximum time to wait (in seconds) for a response before closing the connection
forwarded	string	See default	The choice of setting forwarded/x-forwarded header
followRedirects	http:FollowRedirects	Optional	Configurations associated with Redirection
poolConfig	http:PoolConfiguration	Optional	Configurations associated with request pooling
cache	http:CacheConfig	See default	HTTP caching related configurations
compression	http:Compression	See default	Specifies the way of handling compression (accept-encoding) header
circuitBreaker	http:CircuitBreakerConfig	Optional	Configurations associated with the behaviour of the Circuit Breaker
retryConfig	http:RetryConfig	Optional	Configurations associated with retrying
cookieConfig	http:CookieConfig	Optional	Configurations associated with cookies
responseLimits	http:ResponseLimitConfigs	See default	Configurations associated with inbound response size limits
secureSocket	http:ClientSecureSocket	Optional	SSL/TLS-related options
proxy	http:ProxyConfig	Optional	Proxy server related options
socketConfig	http:ClientSocketConfig	See default	Provides settings related to client socket configuration
validation	boolean	See default	Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
laxDataBinding	boolean	See default	Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).

Initializing the client

import ballerinax/sap.successfactors.ecemployeeprofile;

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

ecemployeeprofile:Client client = check new (
    {
        auth: { username, password }
    },
    hostname
);

Operations

Background_Community

listBackgroundCommunities

Queries the Background_Community collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundCommunitiesQueries	No	Queries to be sent with the request

Returns: ListBackgroundCommunitiesResponse|error

Sample code:

ListBackgroundCommunitiesResponse result = check client->listBackgroundCommunities();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "name": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundCommunity

Creates a new Background_Community entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Community	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Community|error

Sample code:

CreatedBackground_Community result = check client->createBackgroundCommunity(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

getBackgroundCommunity

Retrieves a single Background_Community entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundCommunityQueries	No	Queries to be sent with the request

Returns: Background_Community_1|error

Sample code:

Background_Community_1 result = check client->getBackgroundCommunity(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

updateBackgroundCommunity

Updates the Background_Community identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Community	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundCommunity(backgroundElementId, userId, payload);

deleteBackgroundCommunity

Deletes the Background_Community identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundCommunityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundCommunity(backgroundElementId, userId);

Background_Courses

listBackgroundCoursess

Queries the Background_Courses collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundCoursessQueries	No	Queries to be sent with the request

Returns: ListBackgroundCoursessResponse|error

Sample code:

ListBackgroundCoursessResponse result = check client->listBackgroundCoursess();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "course": "string",
        "endDate": "2026-01-01",
        "lastModifiedDate": "2026-01-01",
        "length": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundCourses

Creates a new Background_Courses entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Courses	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Courses|error

Sample code:

CreatedBackground_Courses result = check client->createBackgroundCourses(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "course": "string",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "length": "string",
    "userId": "1000"
  }
}

getBackgroundCourses

Retrieves a single Background_Courses entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundCoursesQueries	No	Queries to be sent with the request

Returns: Background_Courses_1|error

Sample code:

Background_Courses_1 result = check client->getBackgroundCourses(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "course": "string",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "length": "string",
    "userId": "1000"
  }
}

updateBackgroundCourses

Updates the Background_Courses identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Courses	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundCourses(backgroundElementId, userId, payload);

deleteBackgroundCourses

Deletes the Background_Courses identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundCoursesHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundCourses(backgroundElementId, userId);

Background_Benefitselection

listBackgroundBenefitselections

Queries the Background_Benefitselection collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundBenefitselectionsQueries	No	Queries to be sent with the request

Returns: ListBackgroundBenefitselectionsResponse|error

Sample code:

ListBackgroundBenefitselectionsResponse result = check client->listBackgroundBenefitselections();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "dental": "string",
        "depdisability": "string",
        "depgender": "string",
        "depname": "string",
        "depnationalid": "1000",
        "depsmoke": "string",
        "depstudent": "string",
        "endDate": "2026-01-01",
        "health": "string",
        "lastModifiedDate": "2026-01-01",
        "relation": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundBenefitselection

Creates a new Background_Benefitselection entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Benefitselection	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Benefitselection|error

Sample code:

CreatedBackground_Benefitselection result = check client->createBackgroundBenefitselection(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "dental": "string",
    "depdisability": "string",
    "depgender": "string",
    "depname": "string",
    "depnationalid": "1000",
    "depsmoke": "string",
    "depstudent": "string",
    "endDate": "2026-01-01",
    "health": "string",
    "lastModifiedDate": "2026-01-01",
    "relation": "string",
    "userId": "1000"
  }
}

getBackgroundBenefitselection

Retrieves a single Background_Benefitselection entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundBenefitselectionQueries	No	Queries to be sent with the request

Returns: BackgroundBenefitselection|error

Sample code:

BackgroundBenefitselection result = check client->getBackgroundBenefitselection(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "dental": "string",
    "depdisability": "string",
    "depgender": "string",
    "depname": "string",
    "depnationalid": "1000",
    "depsmoke": "string",
    "depstudent": "string",
    "endDate": "2026-01-01",
    "health": "string",
    "lastModifiedDate": "2026-01-01",
    "relation": "string",
    "userId": "1000"
  }
}

updateBackgroundBenefitselection

Updates the Background_Benefitselection identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Benefitselection	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundBenefitselection(backgroundElementId, userId, payload);

deleteBackgroundBenefitselection

Deletes the Background_Benefitselection identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundBenefitselectionHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundBenefitselection(backgroundElementId, userId);

Background_OutsideWorkExperience

listBackgroundOutsideWorkExperiences

Queries the Background_OutsideWorkExperience collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundOutsideWorkExperiencesQueries	No	Queries to be sent with the request

Returns: ListBackgroundOutsideWorkExperiencesResponse|error

Sample code:

ListBackgroundOutsideWorkExperiencesResponse result = check client->listBackgroundOutsideWorkExperiences();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "employer": "string",
        "endDate": "2026-01-01",
        "lastModifiedDate": "2026-01-01",
        "presentEmployer": "string",
        "startDate": "2026-01-01",
        "startTitle": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundOutsideWorkExperience

Creates a new Background_OutsideWorkExperience entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_OutsideWorkExperience	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_OutsideWorkExperience|error

Sample code:

CreatedBackground_OutsideWorkExperience result = check client->createBackgroundOutsideWorkExperience(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "employer": "string",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "presentEmployer": "string",
    "startDate": "2026-01-01",
    "startTitle": "string",
    "userId": "1000"
  }
}

getBackgroundOutsideWorkExperience

Retrieves a single Background_OutsideWorkExperience entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundOutsideWorkExperienceQueries	No	Queries to be sent with the request

Returns: Background_OutsideWorkExperience_1|error

Sample code:

Background_OutsideWorkExperience_1 result = check client->getBackgroundOutsideWorkExperience(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "employer": "string",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "presentEmployer": "string",
    "startDate": "2026-01-01",
    "startTitle": "string",
    "userId": "1000"
  }
}

updateBackgroundOutsideWorkExperience

Updates the Background_OutsideWorkExperience identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_OutsideWorkExperience	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundOutsideWorkExperience(backgroundElementId, userId, payload);

deleteBackgroundOutsideWorkExperience

Deletes the Background_OutsideWorkExperience identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundOutsideWorkExperienceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundOutsideWorkExperience(backgroundElementId, userId);

Background_Promotability

listBackgroundPromotabilities

Queries the Background_Promotability collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundPromotabilitiesQueries	No	Queries to be sent with the request

Returns: ListBackgroundPromotabilitiesResponse|error

Sample code:

ListBackgroundPromotabilitiesResponse result = check client->listBackgroundPromotabilities();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "level": "string",
        "timeframe": "00:00:00",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundPromotability

Creates a new Background_Promotability entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Promotability	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Promotability|error

Sample code:

CreatedBackground_Promotability result = check client->createBackgroundPromotability(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "level": "string",
    "timeframe": "00:00:00",
    "userId": "1000"
  }
}

getBackgroundPromotability

Retrieves a single Background_Promotability entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundPromotabilityQueries	No	Queries to be sent with the request

Returns: Background_Promotability_1|error

Sample code:

Background_Promotability_1 result = check client->getBackgroundPromotability(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "level": "string",
    "timeframe": "00:00:00",
    "userId": "1000"
  }
}

updateBackgroundPromotability

Updates the Background_Promotability identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Promotability	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundPromotability(backgroundElementId, userId, payload);

deleteBackgroundPromotability

Deletes the Background_Promotability identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundPromotabilityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundPromotability(backgroundElementId, userId);

Background_Fsaelection

listBackgroundFsaelections

Queries the Background_Fsaelection collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundFsaelectionsQueries	No	Queries to be sent with the request

Returns: ListBackgroundFsaelectionsResponse|error

Sample code:

ListBackgroundFsaelectionsResponse result = check client->listBackgroundFsaelections();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundFsaelection

Creates a new Background_Fsaelection entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Fsaelection	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Fsaelection|error

Sample code:

CreatedBackground_Fsaelection result = check client->createBackgroundFsaelection(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundFsaelection

Retrieves a single Background_Fsaelection entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundFsaelectionQueries	No	Queries to be sent with the request

Returns: Background_Fsaelection_1|error

Sample code:

Background_Fsaelection_1 result = check client->getBackgroundFsaelection(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundFsaelection

Updates the Background_Fsaelection identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Fsaelection	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundFsaelection(backgroundElementId, userId, payload);

deleteBackgroundFsaelection

Deletes the Background_Fsaelection identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundFsaelectionHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundFsaelection(backgroundElementId, userId);

Background_Compensation

listBackgroundCompensations

Queries the Background_Compensation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundCompensationsQueries	No	Queries to be sent with the request

Returns: ListBackgroundCompensationsResponse|error

Sample code:

ListBackgroundCompensationsResponse result = check client->listBackgroundCompensations();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundCompensation

Creates a new Background_Compensation entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Compensation	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Compensation|error

Sample code:

CreatedBackground_Compensation result = check client->createBackgroundCompensation(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundCompensation

Retrieves a single Background_Compensation entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundCompensationQueries	No	Queries to be sent with the request

Returns: Background_Compensation_1|error

Sample code:

Background_Compensation_1 result = check client->getBackgroundCompensation(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundCompensation

Updates the Background_Compensation identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Compensation	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundCompensation(backgroundElementId, userId, payload);

deleteBackgroundCompensation

Deletes the Background_Compensation identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundCompensationHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundCompensation(backgroundElementId, userId);

Background_Memberships

listBackgroundMembershipss

Queries the Background_Memberships collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundMembershipssQueries	No	Queries to be sent with the request

Returns: ListBackgroundMembershipssResponse|error

Sample code:

ListBackgroundMembershipssResponse result = check client->listBackgroundMembershipss();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "organization": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundMemberships

Creates a new Background_Memberships entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Memberships	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Memberships|error

Sample code:

CreatedBackground_Memberships result = check client->createBackgroundMemberships(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "organization": "string",
    "userId": "1000"
  }
}

getBackgroundMemberships

Retrieves a single Background_Memberships entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundMembershipsQueries	No	Queries to be sent with the request

Returns: Background_Memberships_1|error

Sample code:

Background_Memberships_1 result = check client->getBackgroundMemberships(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "organization": "string",
    "userId": "1000"
  }
}

updateBackgroundMemberships

Updates the Background_Memberships identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Memberships	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundMemberships(backgroundElementId, userId, payload);

deleteBackgroundMemberships

Deletes the Background_Memberships identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundMembershipsHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundMemberships(backgroundElementId, userId);

Background_Documents

listBackgroundDocumentss

Queries the Background_Documents collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundDocumentssQueries	No	Queries to be sent with the request

Returns: ListBackgroundDocumentssResponse|error

Sample code:

ListBackgroundDocumentssResponse result = check client->listBackgroundDocumentss();

Sample response:

{
  "d": {
    "results": [
      {
        "attachment": 0,
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundDocuments

Creates a new Background_Documents entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Documents	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Documents|error

Sample code:

CreatedBackground_Documents result = check client->createBackgroundDocuments(payload);

Sample response:

{
  "d": {
    "attachment": 0,
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundDocuments

Retrieves a single Background_Documents entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundDocumentsQueries	No	Queries to be sent with the request

Returns: Background_Documents_1|error

Sample code:

Background_Documents_1 result = check client->getBackgroundDocuments(backgroundElementId, userId);

Sample response:

{
  "d": {
    "attachment": 0,
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundDocuments

Updates the Background_Documents identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Documents	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundDocuments(backgroundElementId, userId, payload);

deleteBackgroundDocuments

Deletes the Background_Documents identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundDocumentsHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundDocuments(backgroundElementId, userId);

Background_FuncExperience

listBackgroundFuncExperiences

Queries the Background_FuncExperience collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundFuncExperiencesQueries	No	Queries to be sent with the request

Returns: ListBackgroundFuncExperiencesResponse|error

Sample code:

ListBackgroundFuncExperiencesResponse result = check client->listBackgroundFuncExperiences();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "experience": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000",
        "years": 0
      }
    ]
  }
}

createBackgroundFuncExperience

Creates a new Background_FuncExperience entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_FuncExperience	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_FuncExperience|error

Sample code:

CreatedBackground_FuncExperience result = check client->createBackgroundFuncExperience(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "experience": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "years": 0
  }
}

getBackgroundFuncExperience

Retrieves a single Background_FuncExperience entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundFuncExperienceQueries	No	Queries to be sent with the request

Returns: Background_FuncExperience_1|error

Sample code:

Background_FuncExperience_1 result = check client->getBackgroundFuncExperience(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "experience": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "years": 0
  }
}

updateBackgroundFuncExperience

Updates the Background_FuncExperience identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_FuncExperience	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundFuncExperience(backgroundElementId, userId, payload);

deleteBackgroundFuncExperience

Deletes the Background_FuncExperience identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundFuncExperienceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundFuncExperience(backgroundElementId, userId);

Background_TalentPool

listBackgroundTalentPools

Queries the Background_TalentPool collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundTalentPoolsQueries	No	Queries to be sent with the request

Returns: ListBackgroundTalentPoolsResponse|error

Sample code:

ListBackgroundTalentPoolsResponse result = check client->listBackgroundTalentPools();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "talentPoolitem": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundTalentPool

Creates a new Background_TalentPool entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_TalentPool	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_TalentPool|error

Sample code:

CreatedBackground_TalentPool result = check client->createBackgroundTalentPool(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "talentPoolitem": "string",
    "userId": "1000"
  }
}

getBackgroundTalentPool

Retrieves a single Background_TalentPool entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundTalentPoolQueries	No	Queries to be sent with the request

Returns: Background_TalentPool_1|error

Sample code:

Background_TalentPool_1 result = check client->getBackgroundTalentPool(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "talentPoolitem": "string",
    "userId": "1000"
  }
}

updateBackgroundTalentPool

Updates the Background_TalentPool identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_TalentPool	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundTalentPool(backgroundElementId, userId, payload);

deleteBackgroundTalentPool

Deletes the Background_TalentPool identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundTalentPoolHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundTalentPool(backgroundElementId, userId);

UserBadges

listUserBadgess

Queries the UserBadges collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListUserBadgessQueries	No	Queries to be sent with the request

Returns: ListUserBadgessResponse|error

Sample code:

ListUserBadgessResponse result = check client->listUserBadgess();

Sample response:

{
  "d": {
    "results": [
      {
        "badgeInstanceId": 0,
        "userId": "1000"
      }
    ]
  }
}

createUserBadges

Creates a new UserBadges entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	UserBadges	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedUserBadges|error

Sample code:

CreatedUserBadges result = check client->createUserBadges(payload);

Sample response:

{
  "d": {
    "badgeInstanceId": 0,
    "userId": "1000"
  }
}

getUserBadges

Retrieves a single UserBadges entity identified by its key properties.

Parameters:

Name	Type	Required	Description
badgeInstanceId	int:Signed32	Yes	key: badgeInstanceId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetUserBadgesQueries	No	Queries to be sent with the request

Returns: UserBadges_1|error

Sample code:

UserBadges_1 result = check client->getUserBadges(badgeInstanceId, userId);

Sample response:

{
  "d": {
    "badgeInstanceId": 0,
    "userId": "1000"
  }
}

deleteUserBadges

Deletes the UserBadges identified by its key properties.

Parameters:

Name	Type	Required	Description
badgeInstanceId	int:Signed32	Yes	key: badgeInstanceId
userId	string	Yes	key: userId
headers	DeleteUserBadgesHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteUserBadges(badgeInstanceId, userId);

Background_Googledocs

listBackgroundGoogledocss

Queries the Background_Googledocs collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundGoogledocssQueries	No	Queries to be sent with the request

Returns: ListBackgroundGoogledocssResponse|error

Sample code:

ListBackgroundGoogledocssResponse result = check client->listBackgroundGoogledocss();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "documenturl": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundGoogledocs

Creates a new Background_Googledocs entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Googledocs	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Googledocs|error

Sample code:

CreatedBackground_Googledocs result = check client->createBackgroundGoogledocs(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "documenturl": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundGoogledocs

Retrieves a single Background_Googledocs entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundGoogledocsQueries	No	Queries to be sent with the request

Returns: Background_Googledocs_1|error

Sample code:

Background_Googledocs_1 result = check client->getBackgroundGoogledocs(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "documenturl": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundGoogledocs

Updates the Background_Googledocs identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Googledocs	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundGoogledocs(backgroundElementId, userId, payload);

deleteBackgroundGoogledocs

Deletes the Background_Googledocs identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundGoogledocsHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundGoogledocs(backgroundElementId, userId);

Background_Awards

listBackgroundAwardss

Queries the Background_Awards collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundAwardssQueries	No	Queries to be sent with the request

Returns: ListBackgroundAwardssResponse|error

Sample code:

ListBackgroundAwardssResponse result = check client->listBackgroundAwardss();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "name": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundAwards

Creates a new Background_Awards entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Awards	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Awards|error

Sample code:

CreatedBackground_Awards result = check client->createBackgroundAwards(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

getBackgroundAwards

Retrieves a single Background_Awards entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundAwardsQueries	No	Queries to be sent with the request

Returns: Background_Awards_1|error

Sample code:

Background_Awards_1 result = check client->getBackgroundAwards(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

updateBackgroundAwards

Updates the Background_Awards identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Awards	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundAwards(backgroundElementId, userId, payload);

deleteBackgroundAwards

Deletes the Background_Awards identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundAwardsHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundAwards(backgroundElementId, userId);

Background_Education

listBackgroundEducations

Queries the Background_Education collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundEducationsQueries	No	Queries to be sent with the request

Returns: ListBackgroundEducationsResponse|error

Sample code:

ListBackgroundEducationsResponse result = check client->listBackgroundEducations();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundEducation

Creates a new Background_Education entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Education	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Education|error

Sample code:

CreatedBackground_Education result = check client->createBackgroundEducation(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundEducation

Retrieves a single Background_Education entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundEducationQueries	No	Queries to be sent with the request

Returns: Background_Education_1|error

Sample code:

Background_Education_1 result = check client->getBackgroundEducation(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundEducation

Updates the Background_Education identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Education	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundEducation(backgroundElementId, userId, payload);

deleteBackgroundEducation

Deletes the Background_Education identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundEducationHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundEducation(backgroundElementId, userId);

Background_Mobility

listBackgroundMobilities

Queries the Background_Mobility collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundMobilitiesQueries	No	Queries to be sent with the request

Returns: ListBackgroundMobilitiesResponse|error

Sample code:

ListBackgroundMobilitiesResponse result = check client->listBackgroundMobilities();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000",
        "willingness": "string"
      }
    ]
  }
}

createBackgroundMobility

Creates a new Background_Mobility entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Mobility	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Mobility|error

Sample code:

CreatedBackground_Mobility result = check client->createBackgroundMobility(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "willingness": "string"
  }
}

getBackgroundMobility

Retrieves a single Background_Mobility entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundMobilityQueries	No	Queries to be sent with the request

Returns: Background_Mobility_1|error

Sample code:

Background_Mobility_1 result = check client->getBackgroundMobility(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "willingness": "string"
  }
}

updateBackgroundMobility

Updates the Background_Mobility identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Mobility	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundMobility(backgroundElementId, userId, payload);

deleteBackgroundMobility

Deletes the Background_Mobility identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundMobilityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundMobility(backgroundElementId, userId);

Background_VarPayEmpHistData

listBackgroundVarPayEmpHistData

Queries the Background_VarPayEmpHistData collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundVarPayEmpHistDataQueries	No	Queries to be sent with the request

Returns: ListBackgroundVarPayEmpHistDataResponse|error

Sample code:

ListBackgroundVarPayEmpHistDataResponse result = check client->listBackgroundVarPayEmpHistData();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "endDate": "2026-01-01",
        "lastModifiedDate": "2026-01-01",
        "startDate": "2026-01-01",
        "userId": "1000",
        "varPayProgramName": "string"
      }
    ]
  }
}

createBackgroundVarPayEmpHistData

Creates a new Background_VarPayEmpHistData entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_VarPayEmpHistData	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_VarPayEmpHistData|error

Sample code:

CreatedBackground_VarPayEmpHistData result = check client->createBackgroundVarPayEmpHistData(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "startDate": "2026-01-01",
    "userId": "1000",
    "varPayProgramName": "string"
  }
}

getBackgroundVarPayEmpHistData

Retrieves a single Background_VarPayEmpHistData entity identified by its key property.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundVarPayEmpHistDataQueries	No	Queries to be sent with the request

Returns: Background_VarPayEmpHistData_1|error

Sample code:

Background_VarPayEmpHistData_1 result = check client->getBackgroundVarPayEmpHistData(backgroundElementId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "startDate": "2026-01-01",
    "userId": "1000",
    "varPayProgramName": "string"
  }
}

updateBackgroundVarPayEmpHistData

Updates the Background_VarPayEmpHistData identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
payload	ModifiedBackground_VarPayEmpHistData	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundVarPayEmpHistData(backgroundElementId, payload);

deleteBackgroundVarPayEmpHistData

Deletes the Background_VarPayEmpHistData identified by its key property.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
headers	DeleteBackgroundVarPayEmpHistDataHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundVarPayEmpHistData(backgroundElementId);

Background_InsideWorkExperience

listBackgroundInsideWorkExperiences

Queries the Background_InsideWorkExperience collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundInsideWorkExperiencesQueries	No	Queries to be sent with the request

Returns: ListBackgroundInsideWorkExperiencesResponse|error

Sample code:

ListBackgroundInsideWorkExperiencesResponse result = check client->listBackgroundInsideWorkExperiences();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundInsideWorkExperience

Creates a new Background_InsideWorkExperience entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_InsideWorkExperience	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_InsideWorkExperience|error

Sample code:

CreatedBackground_InsideWorkExperience result = check client->createBackgroundInsideWorkExperience(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundInsideWorkExperience

Retrieves a single Background_InsideWorkExperience entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundInsideWorkExperienceQueries	No	Queries to be sent with the request

Returns: Background_InsideWorkExperience_1|error

Sample code:

Background_InsideWorkExperience_1 result = check client->getBackgroundInsideWorkExperience(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundInsideWorkExperience

Updates the Background_InsideWorkExperience identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_InsideWorkExperience	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundInsideWorkExperience(backgroundElementId, userId, payload);

deleteBackgroundInsideWorkExperience

Deletes the Background_InsideWorkExperience identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundInsideWorkExperienceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundInsideWorkExperience(backgroundElementId, userId);

Background_PreferredNextMove

listBackgroundPreferredNextMoves

Queries the Background_PreferredNextMove collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundPreferredNextMovesQueries	No	Queries to be sent with the request

Returns: ListBackgroundPreferredNextMovesResponse|error

Sample code:

ListBackgroundPreferredNextMovesResponse result = check client->listBackgroundPreferredNextMoves();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "title": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundPreferredNextMove

Creates a new Background_PreferredNextMove entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_PreferredNextMove	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_PreferredNextMove|error

Sample code:

CreatedBackground_PreferredNextMove result = check client->createBackgroundPreferredNextMove(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "title": "string",
    "userId": "1000"
  }
}

getBackgroundPreferredNextMove

Retrieves a single Background_PreferredNextMove entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundPreferredNextMoveQueries	No	Queries to be sent with the request

Returns: Background_PreferredNextMove_1|error

Sample code:

Background_PreferredNextMove_1 result = check client->getBackgroundPreferredNextMove(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "title": "string",
    "userId": "1000"
  }
}

updateBackgroundPreferredNextMove

Updates the Background_PreferredNextMove identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_PreferredNextMove	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundPreferredNextMove(backgroundElementId, userId, payload);

deleteBackgroundPreferredNextMove

Deletes the Background_PreferredNextMove identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundPreferredNextMoveHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundPreferredNextMove(backgroundElementId, userId);

BadgeTemplates

listBadgeTemplatess

Queries the BadgeTemplates collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBadgeTemplatessQueries	No	Queries to be sent with the request

Returns: ListBadgeTemplatessResponse|error

Sample code:

ListBadgeTemplatessResponse result = check client->listBadgeTemplatess();

Sample response:

{
  "d": {
    "results": [
      {
        "badgeId": 0
      }
    ]
  }
}

getBadgeTemplates

Retrieves a single BadgeTemplates entity identified by its key property.

Parameters:

Name	Type	Required	Description
badgeId	int:Signed32	Yes	key: badgeId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBadgeTemplatesQueries	No	Queries to be sent with the request

Returns: BadgeTemplates_1|error

Sample code:

BadgeTemplates_1 result = check client->getBadgeTemplates(badgeId);

Sample response:

{
  "d": {
    "badgeId": 0
  }
}

EPPublicProfile

listEPPublicProfiles

Queries the EPPublicProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListEPPublicProfilesQueries	No	Queries to be sent with the request

Returns: ListEPPublicProfilesResponse|error

Sample code:

ListEPPublicProfilesResponse result = check client->listEPPublicProfiles();

Sample response:

{
  "d": {
    "results": [
      {
        "userId": "1000"
      }
    ]
  }
}

createEPPublicProfile

Creates a new EPPublicProfile entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	EPPublicProfile	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedEPPublicProfile|error

Sample code:

CreatedEPPublicProfile result = check client->createEPPublicProfile(payload);

Sample response:

{
  "d": {
    "userId": "1000"
  }
}

getEPPublicProfile

Retrieves a single EPPublicProfile entity identified by its key property.

Parameters:

Name	Type	Required	Description
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetEPPublicProfileQueries	No	Queries to be sent with the request

Returns: EPPublicProfile_1|error

Sample code:

EPPublicProfile_1 result = check client->getEPPublicProfile(userId);

Sample response:

{
  "d": {
    "userId": "1000"
  }
}

updateEPPublicProfile

Updates the EPPublicProfile identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
userId	string	Yes	key: userId
payload	ModifiedEPPublicProfile	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateEPPublicProfile(userId, payload);

deleteEPPublicProfile

Deletes the EPPublicProfile identified by its key property.

Parameters:

Name	Type	Required	Description
userId	string	Yes	key: userId
headers	DeleteEPPublicProfileHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteEPPublicProfile(userId);

Background_Languages

listBackgroundLanguagess

Queries the Background_Languages collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundLanguagessQueries	No	Queries to be sent with the request

Returns: ListBackgroundLanguagessResponse|error

Sample code:

ListBackgroundLanguagessResponse result = check client->listBackgroundLanguagess();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundLanguages

Creates a new Background_Languages entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Languages	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Languages|error

Sample code:

CreatedBackground_Languages result = check client->createBackgroundLanguages(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundLanguages

Retrieves a single Background_Languages entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundLanguagesQueries	No	Queries to be sent with the request

Returns: Background_Languages_1|error

Sample code:

Background_Languages_1 result = check client->getBackgroundLanguages(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundLanguages

Updates the Background_Languages identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Languages	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundLanguages(backgroundElementId, userId, payload);

deleteBackgroundLanguages

Deletes the Background_Languages identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundLanguagesHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundLanguages(backgroundElementId, userId);

Background_SysScoreCardDevelopmentObjectivesPortlet

listBackgroundSysScoreCardDevelopmentObjectivesPortlets

Queries the Background_SysScoreCardDevelopmentObjectivesPortlet collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundSysScoreCardDevelopmentObjectivesPortletsQueries	No	Queries to be sent with the request

Returns: ListBackgroundSysScoreCardDevelopmentObjectivesPortletsResponse|error

Sample code:

ListBackgroundSysScoreCardDevelopmentObjectivesPortletsResponse result = check client->listBackgroundSysScoreCardDevelopmentObjectivesPortlets();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundSysScoreCardDevelopmentObjectivesPortlet

Creates a new Background_SysScoreCardDevelopmentObjectivesPortlet entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_SysScoreCardDevelopmentObjectivesPortlet	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_SysScoreCardDevelopmentObjectivesPortlet|error

Sample code:

CreatedBackground_SysScoreCardDevelopmentObjectivesPortlet result = check client->createBackgroundSysScoreCardDevelopmentObjectivesPortlet(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundSysScoreCardDevelopmentObjectivesPortlet

Retrieves a single Background_SysScoreCardDevelopmentObjectivesPortlet entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundSysScoreCardDevelopmentObjectivesPortletQueries	No	Queries to be sent with the request

Returns: Background_SysScoreCardDevelopmentObjectivesPortlet_1|error

Sample code:

Background_SysScoreCardDevelopmentObjectivesPortlet_1 result = check client->getBackgroundSysScoreCardDevelopmentObjectivesPortlet(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundSysScoreCardDevelopmentObjectivesPortlet

Updates the Background_SysScoreCardDevelopmentObjectivesPortlet identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_SysScoreCardDevelopmentObjectivesPortlet	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundSysScoreCardDevelopmentObjectivesPortlet(backgroundElementId, userId, payload);

deleteBackgroundSysScoreCardDevelopmentObjectivesPortlet

Deletes the Background_SysScoreCardDevelopmentObjectivesPortlet identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundSysScoreCardDevelopmentObjectivesPortletHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundSysScoreCardDevelopmentObjectivesPortlet(backgroundElementId, userId);

Background_TalentPoolcorp

listBackgroundTalentPoolcorps

Queries the Background_TalentPoolcorp collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundTalentPoolcorpsQueries	No	Queries to be sent with the request

Returns: ListBackgroundTalentPoolcorpsResponse|error

Sample code:

ListBackgroundTalentPoolcorpsResponse result = check client->listBackgroundTalentPoolcorps();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "talentPoolitemCorp": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundTalentPoolcorp

Creates a new Background_TalentPoolcorp entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_TalentPoolcorp	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_TalentPoolcorp|error

Sample code:

CreatedBackground_TalentPoolcorp result = check client->createBackgroundTalentPoolcorp(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "talentPoolitemCorp": "string",
    "userId": "1000"
  }
}

getBackgroundTalentPoolcorp

Retrieves a single Background_TalentPoolcorp entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundTalentPoolcorpQueries	No	Queries to be sent with the request

Returns: Background_TalentPoolcorp_1|error

Sample code:

Background_TalentPoolcorp_1 result = check client->getBackgroundTalentPoolcorp(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "talentPoolitemCorp": "string",
    "userId": "1000"
  }
}

updateBackgroundTalentPoolcorp

Updates the Background_TalentPoolcorp identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_TalentPoolcorp	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundTalentPoolcorp(backgroundElementId, userId, payload);

deleteBackgroundTalentPoolcorp

Deletes the Background_TalentPoolcorp identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundTalentPoolcorpHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundTalentPoolcorp(backgroundElementId, userId);

EPCustomBackgroundPortlet

listEPCustomBackgroundPortlets

Queries the EPCustomBackgroundPortlet collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListEPCustomBackgroundPortletsQueries	No	Queries to be sent with the request

Returns: ListEPCustomBackgroundPortletsResponse|error

Sample code:

ListEPCustomBackgroundPortletsResponse result = check client->listEPCustomBackgroundPortlets();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "backgroundPropertyLists": {}
      }
    ]
  }
}

getEPCustomBackgroundPortlet

Retrieves a single EPCustomBackgroundPortlet entity identified by its key property.

Parameters:

Name	Type	Required	Description
backgroundElementId	string	Yes	key: backgroundElementId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetEPCustomBackgroundPortletQueries	No	Queries to be sent with the request

Returns: EPCustomBackgroundPortlet_1|error

Sample code:

EPCustomBackgroundPortlet_1 result = check client->getEPCustomBackgroundPortlet(backgroundElementId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "backgroundPropertyLists": {}
  }
}

Background_SpecialAssign

listBackgroundSpecialAssigns

Queries the Background_SpecialAssign collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundSpecialAssignsQueries	No	Queries to be sent with the request

Returns: ListBackgroundSpecialAssignsResponse|error

Sample code:

ListBackgroundSpecialAssignsResponse result = check client->listBackgroundSpecialAssigns();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "project": "string",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundSpecialAssign

Creates a new Background_SpecialAssign entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_SpecialAssign	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_SpecialAssign|error

Sample code:

CreatedBackground_SpecialAssign result = check client->createBackgroundSpecialAssign(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "project": "string",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getBackgroundSpecialAssign

Retrieves a single Background_SpecialAssign entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundSpecialAssignQueries	No	Queries to be sent with the request

Returns: Background_SpecialAssign_1|error

Sample code:

Background_SpecialAssign_1 result = check client->getBackgroundSpecialAssign(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "project": "string",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateBackgroundSpecialAssign

Updates the Background_SpecialAssign identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_SpecialAssign	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundSpecialAssign(backgroundElementId, userId, payload);

deleteBackgroundSpecialAssign

Deletes the Background_SpecialAssign identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundSpecialAssignHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundSpecialAssign(backgroundElementId, userId);

Background_Certificates

listBackgroundCertificatess

Queries the Background_Certificates collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundCertificatessQueries	No	Queries to be sent with the request

Returns: ListBackgroundCertificatessResponse|error

Sample code:

ListBackgroundCertificatessResponse result = check client->listBackgroundCertificatess();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "lastModifiedDate": "2026-01-01",
        "name": "string",
        "userId": "1000"
      }
    ]
  }
}

createBackgroundCertificates

Creates a new Background_Certificates entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_Certificates	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_Certificates|error

Sample code:

CreatedBackground_Certificates result = check client->createBackgroundCertificates(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

getBackgroundCertificates

Retrieves a single Background_Certificates entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundCertificatesQueries	No	Queries to be sent with the request

Returns: Background_Certificates_1|error

Sample code:

Background_Certificates_1 result = check client->getBackgroundCertificates(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "lastModifiedDate": "2026-01-01",
    "name": "string",
    "userId": "1000"
  }
}

updateBackgroundCertificates

Updates the Background_Certificates identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_Certificates	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundCertificates(backgroundElementId, userId, payload);

deleteBackgroundCertificates

Deletes the Background_Certificates identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundCertificatesHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundCertificates(backgroundElementId, userId);

Background_VarPayEmpHistDataECSource

listBackgroundVarPayEmpHistDataECSources

Queries the Background_VarPayEmpHistDataECSource collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundVarPayEmpHistDataECSourcesQueries	No	Queries to be sent with the request

Returns: ListBackgroundVarPayEmpHistDataECSourcesResponse|error

Sample code:

ListBackgroundVarPayEmpHistDataECSourcesResponse result = check client->listBackgroundVarPayEmpHistDataECSources();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "endDate": "2026-01-01",
        "lastModifiedDate": "2026-01-01",
        "startDate": "2026-01-01",
        "userId": "1000",
        "varPayProgramName": "string"
      }
    ]
  }
}

createBackgroundVarPayEmpHistDataECSource

Creates a new Background_VarPayEmpHistDataECSource entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_VarPayEmpHistDataECSource	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_VarPayEmpHistDataECSource|error

Sample code:

CreatedBackground_VarPayEmpHistDataECSource result = check client->createBackgroundVarPayEmpHistDataECSource(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "startDate": "2026-01-01",
    "userId": "1000",
    "varPayProgramName": "string"
  }
}

getBackgroundVarPayEmpHistDataECSource

Retrieves a single Background_VarPayEmpHistDataECSource entity identified by its key property.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundVarPayEmpHistDataECSourceQueries	No	Queries to be sent with the request

Returns: Background_VarPayEmpHistDataECSource_1|error

Sample code:

Background_VarPayEmpHistDataECSource_1 result = check client->getBackgroundVarPayEmpHistDataECSource(backgroundElementId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "endDate": "2026-01-01",
    "lastModifiedDate": "2026-01-01",
    "startDate": "2026-01-01",
    "userId": "1000",
    "varPayProgramName": "string"
  }
}

updateBackgroundVarPayEmpHistDataECSource

Updates the Background_VarPayEmpHistDataECSource identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
payload	ModifiedBackground_VarPayEmpHistDataECSource	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundVarPayEmpHistDataECSource(backgroundElementId, payload);

deleteBackgroundVarPayEmpHistDataECSource

Deletes the Background_VarPayEmpHistDataECSource identified by its key property.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
headers	DeleteBackgroundVarPayEmpHistDataECSourceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundVarPayEmpHistDataECSource(backgroundElementId);

Background_LeadExperience

listBackgroundLeadExperiences

Queries the Background_LeadExperience collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListBackgroundLeadExperiencesQueries	No	Queries to be sent with the request

Returns: ListBackgroundLeadExperiencesResponse|error

Sample code:

ListBackgroundLeadExperiencesResponse result = check client->listBackgroundLeadExperiences();

Sample response:

{
  "d": {
    "results": [
      {
        "backgroundElementId": "1000",
        "bgOrderPos": "string",
        "experience": "string",
        "lastModifiedDate": "2026-01-01",
        "userId": "1000",
        "years": 0
      }
    ]
  }
}

createBackgroundLeadExperience

Creates a new Background_LeadExperience entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	Background_LeadExperience	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedBackground_LeadExperience|error

Sample code:

CreatedBackground_LeadExperience result = check client->createBackgroundLeadExperience(payload);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "experience": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "years": 0
  }
}

getBackgroundLeadExperience

Retrieves a single Background_LeadExperience entity identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBackgroundLeadExperienceQueries	No	Queries to be sent with the request

Returns: Background_LeadExperience_1|error

Sample code:

Background_LeadExperience_1 result = check client->getBackgroundLeadExperience(backgroundElementId, userId);

Sample response:

{
  "d": {
    "backgroundElementId": "1000",
    "bgOrderPos": "string",
    "experience": "string",
    "lastModifiedDate": "2026-01-01",
    "userId": "1000",
    "years": 0
  }
}

updateBackgroundLeadExperience

Updates the Background_LeadExperience identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
payload	ModifiedBackground_LeadExperience	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBackgroundLeadExperience(backgroundElementId, userId, payload);

deleteBackgroundLeadExperience

Deletes the Background_LeadExperience identified by its key properties.

Parameters:

Name	Type	Required	Description
backgroundElementId	int	Yes	key: backgroundElementId
userId	string	Yes	key: userId
headers	DeleteBackgroundLeadExperienceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBackgroundLeadExperience(backgroundElementId, userId);

TrendData_SysOverallObjective

listTrendDataSysOverallObjectives

Queries the TrendData_SysOverallObjective collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallObjectivesQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallObjectivesResponse|error

Sample code:

ListTrendDataSysOverallObjectivesResponse result = check client->listTrendDataSysOverallObjectives();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallObjective

Creates a new TrendData_SysOverallObjective entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallObjective	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallObjective|error

Sample code:

CreatedTrendData_SysOverallObjective result = check client->createTrendDataSysOverallObjective(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallObjective

Retrieves a single TrendData_SysOverallObjective entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallObjectiveQueries	No	Queries to be sent with the request

Returns: TrendData_SysOverallObjective_1|error

Sample code:

TrendData_SysOverallObjective_1 result = check client->getTrendDataSysOverallObjective(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallObjective

Updates the TrendData_SysOverallObjective identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallObjective	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallObjective(id, payload);

deleteTrendDataSysOverallObjective

Deletes the TrendData_SysOverallObjective identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallObjectiveHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallObjective(id);

TrendData_SysOverallCompetency

listTrendDataSysOverallCompetencies

Queries the TrendData_SysOverallCompetency collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallCompetenciesQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallCompetenciesResponse|error

Sample code:

ListTrendDataSysOverallCompetenciesResponse result = check client->listTrendDataSysOverallCompetencies();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallCompetency

Creates a new TrendData_SysOverallCompetency entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallCompetency	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallCompetency|error

Sample code:

CreatedTrendData_SysOverallCompetency result = check client->createTrendDataSysOverallCompetency(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallCompetency

Retrieves a single TrendData_SysOverallCompetency entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallCompetencyQueries	No	Queries to be sent with the request

Returns: TrendData_SysOverallCompetency_1|error

Sample code:

TrendData_SysOverallCompetency_1 result = check client->getTrendDataSysOverallCompetency(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallCompetency

Updates the TrendData_SysOverallCompetency identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallCompetency	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallCompetency(id, payload);

deleteTrendDataSysOverallCompetency

Deletes the TrendData_SysOverallCompetency identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallCompetencyHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallCompetency(id);

TrendData_SysOverallPotential

listTrendDataSysOverallPotentials

Queries the TrendData_SysOverallPotential collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallPotentialsQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallPotentialsResponse|error

Sample code:

ListTrendDataSysOverallPotentialsResponse result = check client->listTrendDataSysOverallPotentials();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallPotential

Creates a new TrendData_SysOverallPotential entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallPotential	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallPotential|error

Sample code:

CreatedTrendData_SysOverallPotential result = check client->createTrendDataSysOverallPotential(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallPotential

Retrieves a single TrendData_SysOverallPotential entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallPotentialQueries	No	Queries to be sent with the request

Returns: TrendData_SysOverallPotential_1|error

Sample code:

TrendData_SysOverallPotential_1 result = check client->getTrendDataSysOverallPotential(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallPotential

Updates the TrendData_SysOverallPotential identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallPotential	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallPotential(id, payload);

deleteTrendDataSysOverallPotential

Deletes the TrendData_SysOverallPotential identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallPotentialHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallPotential(id);

TrendData_SysOverallPerformance

listTrendDataSysOverallPerformances

Queries the TrendData_SysOverallPerformance collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallPerformancesQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallPerformancesResponse|error

Sample code:

ListTrendDataSysOverallPerformancesResponse result = check client->listTrendDataSysOverallPerformances();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallPerformance

Creates a new TrendData_SysOverallPerformance entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallPerformance	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallPerformance|error

Sample code:

CreatedTrendData_SysOverallPerformance result = check client->createTrendDataSysOverallPerformance(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallPerformance

Retrieves a single TrendData_SysOverallPerformance entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallPerformanceQueries	No	Queries to be sent with the request

Returns: TrendData_SysOverallPerformance_1|error

Sample code:

TrendData_SysOverallPerformance_1 result = check client->getTrendDataSysOverallPerformance(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallPerformance

Updates the TrendData_SysOverallPerformance identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallPerformance	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallPerformance(id, payload);

deleteTrendDataSysOverallPerformance

Deletes the TrendData_SysOverallPerformance identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallPerformanceHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallPerformance(id);

TrendData_SysOverallCustom1

listTrendDataSysOverallCustom1s

Queries the TrendData_SysOverallCustom1 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallCustom1sQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallCustom1sResponse|error

Sample code:

ListTrendDataSysOverallCustom1sResponse result = check client->listTrendDataSysOverallCustom1s();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallCustom1

Creates a new TrendData_SysOverallCustom1 entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallCustom1	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallCustom1|error

Sample code:

CreatedTrendData_SysOverallCustom1 result = check client->createTrendDataSysOverallCustom1(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallCustom1

Retrieves a single TrendData_SysOverallCustom1 entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallCustom1Queries	No	Queries to be sent with the request

Returns: TrendData_SysOverallCustom1_1|error

Sample code:

TrendData_SysOverallCustom1_1 result = check client->getTrendDataSysOverallCustom1(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallCustom1

Updates the TrendData_SysOverallCustom1 identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallCustom1	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallCustom1(id, payload);

deleteTrendDataSysOverallCustom1

Deletes the TrendData_SysOverallCustom1 identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallCustom1Headers	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallCustom1(id);

TrendData_SysOverallCustom2

listTrendDataSysOverallCustom2s

Queries the TrendData_SysOverallCustom2 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	ListTrendDataSysOverallCustom2sQueries	No	Queries to be sent with the request

Returns: ListTrendDataSysOverallCustom2sResponse|error

Sample code:

ListTrendDataSysOverallCustom2sResponse result = check client->listTrendDataSysOverallCustom2s();

Sample response:

{
  "d": {
    "results": [
      {
        "endDate": "2026-01-01",
        "id": "1000",
        "startDate": "2026-01-01",
        "userId": "1000"
      }
    ]
  }
}

createTrendDataSysOverallCustom2

Creates a new TrendData_SysOverallCustom2 entity from the supplied payload.

Parameters:

Name	Type	Required	Description
payload	TrendData_SysOverallCustom2	Yes	New entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreatedTrendData_SysOverallCustom2|error

Sample code:

CreatedTrendData_SysOverallCustom2 result = check client->createTrendDataSysOverallCustom2(payload);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

getTrendDataSysOverallCustom2

Retrieves a single TrendData_SysOverallCustom2 entity identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetTrendDataSysOverallCustom2Queries	No	Queries to be sent with the request

Returns: TrendData_SysOverallCustom2_1|error

Sample code:

TrendData_SysOverallCustom2_1 result = check client->getTrendDataSysOverallCustom2(id);

Sample response:

{
  "d": {
    "endDate": "2026-01-01",
    "id": "1000",
    "startDate": "2026-01-01",
    "userId": "1000"
  }
}

updateTrendDataSysOverallCustom2

Updates the TrendData_SysOverallCustom2 identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
payload	ModifiedTrendData_SysOverallCustom2	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateTrendDataSysOverallCustom2(id, payload);

deleteTrendDataSysOverallCustom2

Deletes the TrendData_SysOverallCustom2 identified by its key property.

Parameters:

Name	Type	Required	Description
id	int	Yes	key: id
headers	DeleteTrendDataSysOverallCustom2Headers	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteTrendDataSysOverallCustom2(id);