Actions

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

Available clients:

Client	Purpose
Client	Manages ecskillsmanagement objects: CertificationContent, FamilyEntity, CertificationEntity, JobResponsibilityContent, InterviewQuestionContent, JobResponsibilityEntity, RatedSkillMapping, RoleCompetencyBehaviorMappingEntity…, over the SAP SuccessFactors OData v2 API.

---

Client

You can use these APIs to manage the information about employees skills.

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.ecskillsmanagement;

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

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

Operations

CertificationContent

listCertificationContents

Queries the CertificationContent 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	ListCertificationContentsQueries	No	Queries to be sent with the request

Returns: ListCertificationContentsResponse|error

Sample code:

ListCertificationContentsResponse result = check client->listCertificationContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createCertificationContent

Creates a new CertificationContent entity from the supplied payload.

Parameters:

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

Returns: CreatedCertificationContent|error

Sample code:

CreatedCertificationContent result = check client->createCertificationContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getCertificationContent

Retrieves a single CertificationContent entity identified by its key properties.

Parameters:

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

Returns: CertificationContent_1|error

Sample code:

CertificationContent_1 result = check client->getCertificationContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updateCertificationContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateCertificationContent(JobProfile_externalCode, externalCode, payload);

deleteCertificationContent

Deletes the CertificationContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteCertificationContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCertificationContent(JobProfile_externalCode, externalCode);

FamilyEntity

listFamilyEntities

Queries the FamilyEntity 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	ListFamilyEntitiesQueries	No	Queries to be sent with the request

Returns: ListFamilyEntitiesResponse|error

Sample code:

ListFamilyEntitiesResponse result = check client->listFamilyEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "competencies": {},
        "skills": {}
      }
    ]
  }
}

createFamilyEntity

Creates a new FamilyEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedFamilyEntity|error

Sample code:

CreatedFamilyEntity result = check client->createFamilyEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "competencies": {
      "results": []
    },
    "skills": {
      "results": []
    }
  }
}

getFamilyEntity

Retrieves a single FamilyEntity entity identified by its key property.

Parameters:

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

Returns: FamilyEntity_1|error

Sample code:

FamilyEntity_1 result = check client->getFamilyEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "competencies": {
      "results": []
    },
    "skills": {
      "results": []
    }
  }
}

updateFamilyEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateFamilyEntity(externalCode, payload);

deleteFamilyEntity

Deletes the FamilyEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteFamilyEntity(externalCode);

CertificationEntity

listCertificationEntities

Queries the CertificationEntity 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	ListCertificationEntitiesQueries	No	Queries to be sent with the request

Returns: ListCertificationEntitiesResponse|error

Sample code:

ListCertificationEntitiesResponse result = check client->listCertificationEntities();

Sample response:

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

createCertificationEntity

Creates a new CertificationEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedCertificationEntity|error

Sample code:

CreatedCertificationEntity result = check client->createCertificationEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getCertificationEntity

Retrieves a single CertificationEntity entity identified by its key property.

Parameters:

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

Returns: CertificationEntity_1|error

Sample code:

CertificationEntity_1 result = check client->getCertificationEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateCertificationEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateCertificationEntity(externalCode, payload);

deleteCertificationEntity

Deletes the CertificationEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteCertificationEntity(externalCode);

JobResponsibilityContent

listJobResponsibilityContents

Queries the JobResponsibilityContent 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	ListJobResponsibilityContentsQueries	No	Queries to be sent with the request

Returns: ListJobResponsibilityContentsResponse|error

Sample code:

ListJobResponsibilityContentsResponse result = check client->listJobResponsibilityContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createJobResponsibilityContent

Creates a new JobResponsibilityContent entity from the supplied payload.

Parameters:

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

Returns: CreatedJobResponsibilityContent|error

Sample code:

CreatedJobResponsibilityContent result = check client->createJobResponsibilityContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getJobResponsibilityContent

Retrieves a single JobResponsibilityContent entity identified by its key properties.

Parameters:

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

Returns: JobResponsibilityContent_1|error

Sample code:

JobResponsibilityContent_1 result = check client->getJobResponsibilityContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updateJobResponsibilityContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobResponsibilityContent(JobProfile_externalCode, externalCode, payload);

deleteJobResponsibilityContent

Deletes the JobResponsibilityContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteJobResponsibilityContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobResponsibilityContent(JobProfile_externalCode, externalCode);

InterviewQuestionContent

listInterviewQuestionContents

Queries the InterviewQuestionContent 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	ListInterviewQuestionContentsQueries	No	Queries to be sent with the request

Returns: ListInterviewQuestionContentsResponse|error

Sample code:

ListInterviewQuestionContentsResponse result = check client->listInterviewQuestionContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createInterviewQuestionContent

Creates a new InterviewQuestionContent entity from the supplied payload.

Parameters:

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

Returns: CreatedInterviewQuestionContent|error

Sample code:

CreatedInterviewQuestionContent result = check client->createInterviewQuestionContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getInterviewQuestionContent

Retrieves a single InterviewQuestionContent entity identified by its key properties.

Parameters:

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

Returns: InterviewQuestionContent_1|error

Sample code:

InterviewQuestionContent_1 result = check client->getInterviewQuestionContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updateInterviewQuestionContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateInterviewQuestionContent(JobProfile_externalCode, externalCode, payload);

deleteInterviewQuestionContent

Deletes the InterviewQuestionContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteInterviewQuestionContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteInterviewQuestionContent(JobProfile_externalCode, externalCode);

JobResponsibilityEntity

listJobResponsibilityEntities

Queries the JobResponsibilityEntity 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	ListJobResponsibilityEntitiesQueries	No	Queries to be sent with the request

Returns: ListJobResponsibilityEntitiesResponse|error

Sample code:

ListJobResponsibilityEntitiesResponse result = check client->listJobResponsibilityEntities();

Sample response:

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

createJobResponsibilityEntity

Creates a new JobResponsibilityEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedJobResponsibilityEntity|error

Sample code:

CreatedJobResponsibilityEntity result = check client->createJobResponsibilityEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getJobResponsibilityEntity

Retrieves a single JobResponsibilityEntity entity identified by its key property.

Parameters:

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

Returns: JobResponsibilityEntity_1|error

Sample code:

JobResponsibilityEntity_1 result = check client->getJobResponsibilityEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateJobResponsibilityEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobResponsibilityEntity(externalCode, payload);

deleteJobResponsibilityEntity

Deletes the JobResponsibilityEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteJobResponsibilityEntity(externalCode);

RatedSkillMapping

listRatedSkillMappings

Queries the RatedSkillMapping 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	ListRatedSkillMappingsQueries	No	Queries to be sent with the request

Returns: ListRatedSkillMappingsResponse|error

Sample code:

ListRatedSkillMappingsResponse result = check client->listRatedSkillMappings();

Sample response:

{
  "d": {
    "results": [
      {
        "SkillProfile_externalCode": "1000",
        "externalCode": "1000",
        "skillNav": {}
      }
    ]
  }
}

createRatedSkillMapping

Creates a new RatedSkillMapping entity from the supplied payload.

Parameters:

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

Returns: CreatedRatedSkillMapping|error

Sample code:

CreatedRatedSkillMapping result = check client->createRatedSkillMapping(payload);

Sample response:

{
  "d": {
    "SkillProfile_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

getRatedSkillMapping

Retrieves a single RatedSkillMapping entity identified by its key properties.

Parameters:

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

Returns: RatedSkillMapping_1|error

Sample code:

RatedSkillMapping_1 result = check client->getRatedSkillMapping(SkillProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "SkillProfile_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

updateRatedSkillMapping

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRatedSkillMapping(SkillProfile_externalCode, externalCode, payload);

deleteRatedSkillMapping

Deletes the RatedSkillMapping identified by its key properties.

Parameters:

Name	Type	Required	Description
SkillProfile_externalCode	string	Yes	key: SkillProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRatedSkillMappingHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRatedSkillMapping(SkillProfile_externalCode, externalCode);

RoleCompetencyBehaviorMappingEntity

listRoleCompetencyBehaviorMappingEntities

Queries the RoleCompetencyBehaviorMappingEntity 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	ListRoleCompetencyBehaviorMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListRoleCompetencyBehaviorMappingEntitiesResponse|error

Sample code:

ListRoleCompetencyBehaviorMappingEntitiesResponse result = check client->listRoleCompetencyBehaviorMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "RoleEntity_externalCode": "1000",
        "externalCode": "1000",
        "behaviorMappingEntityNav": {},
        "competencyNav": {}
      }
    ]
  }
}

createRoleCompetencyBehaviorMappingEntity

Creates a new RoleCompetencyBehaviorMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRoleCompetencyBehaviorMappingEntity|error

Sample code:

CreatedRoleCompetencyBehaviorMappingEntity result = check client->createRoleCompetencyBehaviorMappingEntity(payload);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "behaviorMappingEntityNav": {
      "CompetencyEntity_externalCode": "1000",
      "externalCode": "1000"
    },
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

getRoleCompetencyBehaviorMappingEntity

Retrieves a single RoleCompetencyBehaviorMappingEntity entity identified by its key properties.

Parameters:

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

Returns: RoleCompetencyBehaviorMappingEntity_1|error

Sample code:

RoleCompetencyBehaviorMappingEntity_1 result = check client->getRoleCompetencyBehaviorMappingEntity(RoleEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "behaviorMappingEntityNav": {
      "CompetencyEntity_externalCode": "1000",
      "externalCode": "1000"
    },
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

updateRoleCompetencyBehaviorMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRoleCompetencyBehaviorMappingEntity(RoleEntity_externalCode, externalCode, payload);

deleteRoleCompetencyBehaviorMappingEntity

Deletes the RoleCompetencyBehaviorMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
RoleEntity_externalCode	string	Yes	key: RoleEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRoleCompetencyBehaviorMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRoleCompetencyBehaviorMappingEntity(RoleEntity_externalCode, externalCode);

RoleEntity

listRoleEntities

Queries the RoleEntity 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	ListRoleEntitiesQueries	No	Queries to be sent with the request

Returns: ListRoleEntitiesResponse|error

Sample code:

ListRoleEntitiesResponse result = check client->listRoleEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "familyNav": {},
        "jobCodeMappings": {},
        "roleCompetencyBehaviorMappings": {},
        "roleCompetencyMappings": {},
        "roleSkillMappings": {},
        "roleTalentPoolMappings": {}
      }
    ]
  }
}

createRoleEntity

Creates a new RoleEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRoleEntity|error

Sample code:

CreatedRoleEntity result = check client->createRoleEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "familyNav": {
      "externalCode": "1000",
      "competencies": {},
      "skills": {}
    },
    "jobCodeMappings": {
      "results": []
    },
    "roleCompetencyBehaviorMappings": {
      "results": []
    },
    "roleCompetencyMappings": {
      "results": []
    },
    "roleSkillMappings": {
      "results": []
    },
    "roleTalentPoolMappings": {
      "results": []
    }
  }
}

getRoleEntity

Retrieves a single RoleEntity entity identified by its key property.

Parameters:

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

Returns: RoleEntity_1|error

Sample code:

RoleEntity_1 result = check client->getRoleEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "familyNav": {
      "externalCode": "1000",
      "competencies": {},
      "skills": {}
    },
    "jobCodeMappings": {
      "results": []
    },
    "roleCompetencyBehaviorMappings": {
      "results": []
    },
    "roleCompetencyMappings": {
      "results": []
    },
    "roleSkillMappings": {
      "results": []
    },
    "roleTalentPoolMappings": {
      "results": []
    }
  }
}

updateRoleEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRoleEntity(externalCode, payload);

deleteRoleEntity

Deletes the RoleEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteRoleEntity(externalCode);

JobProfileLocalizedData

listJobProfileLocalizedData

Queries the JobProfileLocalizedData 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	ListJobProfileLocalizedDataQueries	No	Queries to be sent with the request

Returns: ListJobProfileLocalizedDataResponse|error

Sample code:

ListJobProfileLocalizedDataResponse result = check client->listJobProfileLocalizedData();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobProfileLocalizedData

Creates a new JobProfileLocalizedData entity from the supplied payload.

Parameters:

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

Returns: CreatedJobProfileLocalizedData|error

Sample code:

CreatedJobProfileLocalizedData result = check client->createJobProfileLocalizedData(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobProfileLocalizedData

Retrieves a single JobProfileLocalizedData entity identified by its key properties.

Parameters:

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

Returns: JobProfileLocalizedData_1|error

Sample code:

JobProfileLocalizedData_1 result = check client->getJobProfileLocalizedData(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateJobProfileLocalizedData

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobProfileLocalizedData(JobProfile_externalCode, externalCode, payload);

deleteJobProfileLocalizedData

Deletes the JobProfileLocalizedData identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteJobProfileLocalizedDataHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobProfileLocalizedData(JobProfile_externalCode, externalCode);

JobCodeMappingEntity

listJobCodeMappingEntities

Queries the JobCodeMappingEntity 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	ListJobCodeMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListJobCodeMappingEntitiesResponse|error

Sample code:

ListJobCodeMappingEntitiesResponse result = check client->listJobCodeMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "RoleEntity_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobCodeMappingEntity

Creates a new JobCodeMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedJobCodeMappingEntity|error

Sample code:

CreatedJobCodeMappingEntity result = check client->createJobCodeMappingEntity(payload);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobCodeMappingEntity

Retrieves a single JobCodeMappingEntity entity identified by its key properties.

Parameters:

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

Returns: JobCodeMappingEntity_1|error

Sample code:

JobCodeMappingEntity_1 result = check client->getJobCodeMappingEntity(RoleEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateJobCodeMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobCodeMappingEntity(RoleEntity_externalCode, externalCode, payload);

deleteJobCodeMappingEntity

Deletes the JobCodeMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
RoleEntity_externalCode	string	Yes	key: RoleEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteJobCodeMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobCodeMappingEntity(RoleEntity_externalCode, externalCode);

CompetencyType

listCompetencyTypes

Queries the CompetencyType 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	ListCompetencyTypesQueries	No	Queries to be sent with the request

Returns: ListCompetencyTypesResponse|error

Sample code:

ListCompetencyTypesResponse result = check client->listCompetencyTypes();

Sample response:

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

createCompetencyType

Creates a new CompetencyType entity from the supplied payload.

Parameters:

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

Returns: CreatedCompetencyType|error

Sample code:

CreatedCompetencyType result = check client->createCompetencyType(payload);

Sample response:

{
  "d": {
    "GUID": "1000"
  }
}

getCompetencyType

Retrieves a single CompetencyType entity identified by its key property.

Parameters:

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

Returns: CompetencyType|error

Sample code:

CompetencyType result = check client->getCompetencyType(GUID);

Sample response:

{
  "d": {
    "GUID": "1000"
  }
}

updateCompetencyType

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

Parameters:

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

Returns: error?

Sample code:

check client->updateCompetencyType(GUID, payload);

deleteCompetencyType

Deletes the CompetencyType identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteCompetencyType(GUID);

EmploymentConditionContent

listEmploymentConditionContents

Queries the EmploymentConditionContent 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	ListEmploymentConditionContentsQueries	No	Queries to be sent with the request

Returns: ListEmploymentConditionContentsResponse|error

Sample code:

ListEmploymentConditionContentsResponse result = check client->listEmploymentConditionContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createEmploymentConditionContent

Creates a new EmploymentConditionContent entity from the supplied payload.

Parameters:

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

Returns: CreatedEmploymentConditionContent|error

Sample code:

CreatedEmploymentConditionContent result = check client->createEmploymentConditionContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getEmploymentConditionContent

Retrieves a single EmploymentConditionContent entity identified by its key properties.

Parameters:

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

Returns: EmploymentConditionContent_1|error

Sample code:

EmploymentConditionContent_1 result = check client->getEmploymentConditionContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updateEmploymentConditionContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateEmploymentConditionContent(JobProfile_externalCode, externalCode, payload);

deleteEmploymentConditionContent

Deletes the EmploymentConditionContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteEmploymentConditionContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteEmploymentConditionContent(JobProfile_externalCode, externalCode);

FamilyCompetencyMappingEntity

listFamilyCompetencyMappingEntities

Queries the FamilyCompetencyMappingEntity 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	ListFamilyCompetencyMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListFamilyCompetencyMappingEntitiesResponse|error

Sample code:

ListFamilyCompetencyMappingEntitiesResponse result = check client->listFamilyCompetencyMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "FamilyEntity_externalCode": "1000",
        "externalCode": "1000",
        "competencyNav": {}
      }
    ]
  }
}

createFamilyCompetencyMappingEntity

Creates a new FamilyCompetencyMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedFamilyCompetencyMappingEntity|error

Sample code:

CreatedFamilyCompetencyMappingEntity result = check client->createFamilyCompetencyMappingEntity(payload);

Sample response:

{
  "d": {
    "FamilyEntity_externalCode": "1000",
    "externalCode": "1000",
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

getFamilyCompetencyMappingEntity

Retrieves a single FamilyCompetencyMappingEntity entity identified by its key properties.

Parameters:

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

Returns: FamilyCompetencyMappingEntity_1|error

Sample code:

FamilyCompetencyMappingEntity_1 result = check client->getFamilyCompetencyMappingEntity(FamilyEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "FamilyEntity_externalCode": "1000",
    "externalCode": "1000",
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

updateFamilyCompetencyMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateFamilyCompetencyMappingEntity(FamilyEntity_externalCode, externalCode, payload);

deleteFamilyCompetencyMappingEntity

Deletes the FamilyCompetencyMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
FamilyEntity_externalCode	string	Yes	key: FamilyEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteFamilyCompetencyMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFamilyCompetencyMappingEntity(FamilyEntity_externalCode, externalCode);

PhysicalReqEntity

listPhysicalReqEntities

Queries the PhysicalReqEntity 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	ListPhysicalReqEntitiesQueries	No	Queries to be sent with the request

Returns: ListPhysicalReqEntitiesResponse|error

Sample code:

ListPhysicalReqEntitiesResponse result = check client->listPhysicalReqEntities();

Sample response:

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

createPhysicalReqEntity

Creates a new PhysicalReqEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedPhysicalReqEntity|error

Sample code:

CreatedPhysicalReqEntity result = check client->createPhysicalReqEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getPhysicalReqEntity

Retrieves a single PhysicalReqEntity entity identified by its key property.

Parameters:

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

Returns: PhysicalReqEntity_1|error

Sample code:

PhysicalReqEntity_1 result = check client->getPhysicalReqEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updatePhysicalReqEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePhysicalReqEntity(externalCode, payload);

deletePhysicalReqEntity

Deletes the PhysicalReqEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deletePhysicalReqEntity(externalCode);

InterviewQuestionEntity

listInterviewQuestionEntities

Queries the InterviewQuestionEntity 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	ListInterviewQuestionEntitiesQueries	No	Queries to be sent with the request

Returns: ListInterviewQuestionEntitiesResponse|error

Sample code:

ListInterviewQuestionEntitiesResponse result = check client->listInterviewQuestionEntities();

Sample response:

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

createInterviewQuestionEntity

Creates a new InterviewQuestionEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedInterviewQuestionEntity|error

Sample code:

CreatedInterviewQuestionEntity result = check client->createInterviewQuestionEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getInterviewQuestionEntity

Retrieves a single InterviewQuestionEntity entity identified by its key property.

Parameters:

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

Returns: InterviewQuestionEntity_1|error

Sample code:

InterviewQuestionEntity_1 result = check client->getInterviewQuestionEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateInterviewQuestionEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateInterviewQuestionEntity(externalCode, payload);

deleteInterviewQuestionEntity

Deletes the InterviewQuestionEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteInterviewQuestionEntity(externalCode);

JDTemplateFamilyMapping

listJDTemplateFamilyMappings

Queries the JDTemplateFamilyMapping 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	ListJDTemplateFamilyMappingsQueries	No	Queries to be sent with the request

Returns: ListJDTemplateFamilyMappingsResponse|error

Sample code:

ListJDTemplateFamilyMappingsResponse result = check client->listJDTemplateFamilyMappings();

Sample response:

{
  "d": {
    "results": [
      {
        "JobDescTemplate_externalCode": "1000",
        "externalCode": "1000",
        "familyNav": {}
      }
    ]
  }
}

createJDTemplateFamilyMapping

Creates a new JDTemplateFamilyMapping entity from the supplied payload.

Parameters:

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

Returns: CreatedJDTemplateFamilyMapping|error

Sample code:

CreatedJDTemplateFamilyMapping result = check client->createJDTemplateFamilyMapping(payload);

Sample response:

{
  "d": {
    "JobDescTemplate_externalCode": "1000",
    "externalCode": "1000",
    "familyNav": {
      "externalCode": "1000",
      "competencies": {},
      "skills": {}
    }
  }
}

getJDTemplateFamilyMapping

Retrieves a single JDTemplateFamilyMapping entity identified by its key properties.

Parameters:

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

Returns: JDTemplateFamilyMapping_1|error

Sample code:

JDTemplateFamilyMapping_1 result = check client->getJDTemplateFamilyMapping(JobDescTemplate_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobDescTemplate_externalCode": "1000",
    "externalCode": "1000",
    "familyNav": {
      "externalCode": "1000",
      "competencies": {},
      "skills": {}
    }
  }
}

updateJDTemplateFamilyMapping

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJDTemplateFamilyMapping(JobDescTemplate_externalCode, externalCode, payload);

deleteJDTemplateFamilyMapping

Deletes the JDTemplateFamilyMapping identified by its key properties.

Parameters:

Name	Type	Required	Description
JobDescTemplate_externalCode	string	Yes	key: JobDescTemplate_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteJDTemplateFamilyMappingHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJDTemplateFamilyMapping(JobDescTemplate_externalCode, externalCode);

BehaviorMappingEntity

listBehaviorMappingEntities

Queries the BehaviorMappingEntity 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	ListBehaviorMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListBehaviorMappingEntitiesResponse|error

Sample code:

ListBehaviorMappingEntitiesResponse result = check client->listBehaviorMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "CompetencyEntity_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createBehaviorMappingEntity

Creates a new BehaviorMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedBehaviorMappingEntity|error

Sample code:

CreatedBehaviorMappingEntity result = check client->createBehaviorMappingEntity(payload);

Sample response:

{
  "d": {
    "CompetencyEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getBehaviorMappingEntity

Retrieves a single BehaviorMappingEntity entity identified by its key properties.

Parameters:

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

Returns: BehaviorMappingEntity_1|error

Sample code:

BehaviorMappingEntity_1 result = check client->getBehaviorMappingEntity(CompetencyEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "CompetencyEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateBehaviorMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateBehaviorMappingEntity(CompetencyEntity_externalCode, externalCode, payload);

deleteBehaviorMappingEntity

Deletes the BehaviorMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
CompetencyEntity_externalCode	string	Yes	key: CompetencyEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteBehaviorMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBehaviorMappingEntity(CompetencyEntity_externalCode, externalCode);

SkillEntity

listSkillEntities

Queries the SkillEntity 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	ListSkillEntitiesQueries	No	Queries to be sent with the request

Returns: ListSkillEntitiesResponse|error

Sample code:

ListSkillEntitiesResponse result = check client->listSkillEntities();

Sample response:

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

createSkillEntity

Creates a new SkillEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedSkillEntity|error

Sample code:

CreatedSkillEntity result = check client->createSkillEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getSkillEntity

Retrieves a single SkillEntity entity identified by its key property.

Parameters:

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

Returns: SkillEntity_1|error

Sample code:

SkillEntity_1 result = check client->getSkillEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateSkillEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateSkillEntity(externalCode, payload);

deleteSkillEntity

Deletes the SkillEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteSkillEntity(externalCode);

PhysicalReqContent

listPhysicalReqContents

Queries the PhysicalReqContent 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	ListPhysicalReqContentsQueries	No	Queries to be sent with the request

Returns: ListPhysicalReqContentsResponse|error

Sample code:

ListPhysicalReqContentsResponse result = check client->listPhysicalReqContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createPhysicalReqContent

Creates a new PhysicalReqContent entity from the supplied payload.

Parameters:

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

Returns: CreatedPhysicalReqContent|error

Sample code:

CreatedPhysicalReqContent result = check client->createPhysicalReqContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getPhysicalReqContent

Retrieves a single PhysicalReqContent entity identified by its key properties.

Parameters:

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

Returns: PhysicalReqContent_1|error

Sample code:

PhysicalReqContent_1 result = check client->getPhysicalReqContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updatePhysicalReqContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePhysicalReqContent(JobProfile_externalCode, externalCode, payload);

deletePhysicalReqContent

Deletes the PhysicalReqContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeletePhysicalReqContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePhysicalReqContent(JobProfile_externalCode, externalCode);

SkillContent

listSkillContents

Queries the SkillContent 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	ListSkillContentsQueries	No	Queries to be sent with the request

Returns: ListSkillContentsResponse|error

Sample code:

ListSkillContentsResponse result = check client->listSkillContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {},
        "roleNav": {}
      }
    ]
  }
}

createSkillContent

Creates a new SkillContent entity from the supplied payload.

Parameters:

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

Returns: CreatedSkillContent|error

Sample code:

CreatedSkillContent result = check client->createSkillContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    },
    "roleNav": {
      "externalCode": "1000",
      "familyNav": {},
      "jobCodeMappings": {},
      "roleCompetencyBehaviorMappings": {},
      "roleCompetencyMappings": {},
      "roleSkillMappings": {},
      "roleTalentPoolMappings": {}
    }
  }
}

getSkillContent

Retrieves a single SkillContent entity identified by its key properties.

Parameters:

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

Returns: SkillContent_1|error

Sample code:

SkillContent_1 result = check client->getSkillContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    },
    "roleNav": {
      "externalCode": "1000",
      "familyNav": {},
      "jobCodeMappings": {},
      "roleCompetencyBehaviorMappings": {},
      "roleCompetencyMappings": {},
      "roleSkillMappings": {},
      "roleTalentPoolMappings": {}
    }
  }
}

updateSkillContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateSkillContent(JobProfile_externalCode, externalCode, payload);

deleteSkillContent

Deletes the SkillContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteSkillContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSkillContent(JobProfile_externalCode, externalCode);

RoleCompetencyMappingEntity

listRoleCompetencyMappingEntities

Queries the RoleCompetencyMappingEntity 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	ListRoleCompetencyMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListRoleCompetencyMappingEntitiesResponse|error

Sample code:

ListRoleCompetencyMappingEntitiesResponse result = check client->listRoleCompetencyMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "RoleEntity_externalCode": "1000",
        "externalCode": "1000",
        "competencyNav": {}
      }
    ]
  }
}

createRoleCompetencyMappingEntity

Creates a new RoleCompetencyMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRoleCompetencyMappingEntity|error

Sample code:

CreatedRoleCompetencyMappingEntity result = check client->createRoleCompetencyMappingEntity(payload);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

getRoleCompetencyMappingEntity

Retrieves a single RoleCompetencyMappingEntity entity identified by its key properties.

Parameters:

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

Returns: RoleCompetencyMappingEntity_1|error

Sample code:

RoleCompetencyMappingEntity_1 result = check client->getRoleCompetencyMappingEntity(RoleEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "competencyNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    }
  }
}

updateRoleCompetencyMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRoleCompetencyMappingEntity(RoleEntity_externalCode, externalCode, payload);

deleteRoleCompetencyMappingEntity

Deletes the RoleCompetencyMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
RoleEntity_externalCode	string	Yes	key: RoleEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRoleCompetencyMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRoleCompetencyMappingEntity(RoleEntity_externalCode, externalCode);

SelfReportSkillMapping

listSelfReportSkillMappings

Queries the SelfReportSkillMapping 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	ListSelfReportSkillMappingsQueries	No	Queries to be sent with the request

Returns: ListSelfReportSkillMappingsResponse|error

Sample code:

ListSelfReportSkillMappingsResponse result = check client->listSelfReportSkillMappings();

Sample response:

{
  "d": {
    "results": [
      {
        "SkillProfile_externalCode": "1000",
        "externalCode": "1000",
        "skillNav": {}
      }
    ]
  }
}

createSelfReportSkillMapping

Creates a new SelfReportSkillMapping entity from the supplied payload.

Parameters:

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

Returns: CreatedSelfReportSkillMapping|error

Sample code:

CreatedSelfReportSkillMapping result = check client->createSelfReportSkillMapping(payload);

Sample response:

{
  "d": {
    "SkillProfile_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

getSelfReportSkillMapping

Retrieves a single SelfReportSkillMapping entity identified by its key properties.

Parameters:

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

Returns: SelfReportSkillMapping_1|error

Sample code:

SelfReportSkillMapping_1 result = check client->getSelfReportSkillMapping(SkillProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "SkillProfile_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

updateSelfReportSkillMapping

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

Parameters:

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

Returns: error?

Sample code:

check client->updateSelfReportSkillMapping(SkillProfile_externalCode, externalCode, payload);

deleteSelfReportSkillMapping

Deletes the SelfReportSkillMapping identified by its key properties.

Parameters:

Name	Type	Required	Description
SkillProfile_externalCode	string	Yes	key: SkillProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteSelfReportSkillMappingHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteSelfReportSkillMapping(SkillProfile_externalCode, externalCode);

JobProfile

listJobProfiles

Queries the JobProfile 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	ListJobProfilesQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listJobProfiles();

getJobProfile

Retrieves a single JobProfile entity identified by its key property.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getJobProfile(externalCode);

deleteJobProfile

Deletes the JobProfile identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteJobProfile(externalCode);

FamilySkillMappingEntity

listFamilySkillMappingEntities

Queries the FamilySkillMappingEntity 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	ListFamilySkillMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListFamilySkillMappingEntitiesResponse|error

Sample code:

ListFamilySkillMappingEntitiesResponse result = check client->listFamilySkillMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "FamilyEntity_externalCode": "1000",
        "externalCode": "1000",
        "skillNav": {}
      }
    ]
  }
}

createFamilySkillMappingEntity

Creates a new FamilySkillMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedFamilySkillMappingEntity|error

Sample code:

CreatedFamilySkillMappingEntity result = check client->createFamilySkillMappingEntity(payload);

Sample response:

{
  "d": {
    "FamilyEntity_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

getFamilySkillMappingEntity

Retrieves a single FamilySkillMappingEntity entity identified by its key properties.

Parameters:

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

Returns: FamilySkillMappingEntity_1|error

Sample code:

FamilySkillMappingEntity_1 result = check client->getFamilySkillMappingEntity(FamilyEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "FamilyEntity_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

updateFamilySkillMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateFamilySkillMappingEntity(FamilyEntity_externalCode, externalCode, payload);

deleteFamilySkillMappingEntity

Deletes the FamilySkillMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
FamilyEntity_externalCode	string	Yes	key: FamilyEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteFamilySkillMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFamilySkillMappingEntity(FamilyEntity_externalCode, externalCode);

RoleSkillMappingEntity

listRoleSkillMappingEntities

Queries the RoleSkillMappingEntity 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	ListRoleSkillMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListRoleSkillMappingEntitiesResponse|error

Sample code:

ListRoleSkillMappingEntitiesResponse result = check client->listRoleSkillMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "RoleEntity_externalCode": "1000",
        "externalCode": "1000",
        "skillNav": {}
      }
    ]
  }
}

createRoleSkillMappingEntity

Creates a new RoleSkillMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRoleSkillMappingEntity|error

Sample code:

CreatedRoleSkillMappingEntity result = check client->createRoleSkillMappingEntity(payload);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

getRoleSkillMappingEntity

Retrieves a single RoleSkillMappingEntity entity identified by its key properties.

Parameters:

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

Returns: RoleSkillMappingEntity_1|error

Sample code:

RoleSkillMappingEntity_1 result = check client->getRoleSkillMappingEntity(RoleEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000",
    "skillNav": {
      "externalCode": "1000"
    }
  }
}

updateRoleSkillMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRoleSkillMappingEntity(RoleEntity_externalCode, externalCode, payload);

deleteRoleSkillMappingEntity

Deletes the RoleSkillMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
RoleEntity_externalCode	string	Yes	key: RoleEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRoleSkillMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRoleSkillMappingEntity(RoleEntity_externalCode, externalCode);

JobDescTemplate

listJobDescTemplates

Queries the JobDescTemplate 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	ListJobDescTemplatesQueries	No	Queries to be sent with the request

Returns: ListJobDescTemplatesResponse|error

Sample code:

ListJobDescTemplatesResponse result = check client->listJobDescTemplates();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "jdFamilyMappings": {},
        "sections": {}
      }
    ]
  }
}

createJobDescTemplate

Creates a new JobDescTemplate entity from the supplied payload.

Parameters:

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

Returns: CreatedJobDescTemplate|error

Sample code:

CreatedJobDescTemplate result = check client->createJobDescTemplate(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "jdFamilyMappings": {
      "results": []
    },
    "sections": {
      "results": []
    }
  }
}

getJobDescTemplate

Retrieves a single JobDescTemplate entity identified by its key property.

Parameters:

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

Returns: JobDescTemplate_1|error

Sample code:

JobDescTemplate_1 result = check client->getJobDescTemplate(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "jdFamilyMappings": {
      "results": []
    },
    "sections": {
      "results": []
    }
  }
}

updateJobDescTemplate

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobDescTemplate(externalCode, payload);

deleteJobDescTemplate

Deletes the JobDescTemplate identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteJobDescTemplate(externalCode);

SkillProfile

listSkillProfiles

Queries the SkillProfile 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	ListSkillProfilesQueries	No	Queries to be sent with the request

Returns: ListSkillProfilesResponse|error

Sample code:

ListSkillProfilesResponse result = check client->listSkillProfiles();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "ratedSkills": {},
        "selfReportSkills": {}
      }
    ]
  }
}

createSkillProfile

Creates a new SkillProfile entity from the supplied payload.

Parameters:

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

Returns: CreatedSkillProfile|error

Sample code:

CreatedSkillProfile result = check client->createSkillProfile(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "ratedSkills": {
      "results": []
    },
    "selfReportSkills": {
      "results": []
    }
  }
}

getSkillProfile

Retrieves a single SkillProfile entity identified by its key property.

Parameters:

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

Returns: SkillProfile_1|error

Sample code:

SkillProfile_1 result = check client->getSkillProfile(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "ratedSkills": {
      "results": []
    },
    "selfReportSkills": {
      "results": []
    }
  }
}

updateSkillProfile

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

Parameters:

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

Returns: error?

Sample code:

check client->updateSkillProfile(externalCode, payload);

deleteSkillProfile

Deletes the SkillProfile identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteSkillProfile(externalCode);

CompetencyEntity

listCompetencyEntities

Queries the CompetencyEntity 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	ListCompetencyEntitiesQueries	No	Queries to be sent with the request

Returns: ListCompetencyEntitiesResponse|error

Sample code:

ListCompetencyEntitiesResponse result = check client->listCompetencyEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "behaviors": {},
        "competencies": {},
        "competencyTypes": {}
      }
    ]
  }
}

createCompetencyEntity

Creates a new CompetencyEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedCompetencyEntity|error

Sample code:

CreatedCompetencyEntity result = check client->createCompetencyEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "behaviors": {
      "results": []
    },
    "competencies": {
      "results": []
    },
    "competencyTypes": {
      "results": []
    }
  }
}

getCompetencyEntity

Retrieves a single CompetencyEntity entity identified by its key property.

Parameters:

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

Returns: CompetencyEntity_1|error

Sample code:

CompetencyEntity_1 result = check client->getCompetencyEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "behaviors": {
      "results": []
    },
    "competencies": {
      "results": []
    },
    "competencyTypes": {
      "results": []
    }
  }
}

updateCompetencyEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateCompetencyEntity(externalCode, payload);

deleteCompetencyEntity

Deletes the CompetencyEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteCompetencyEntity(externalCode);

CompetencyContent

listCompetencyContents

Queries the CompetencyContent 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	ListCompetencyContentsQueries	No	Queries to be sent with the request

Returns: ListCompetencyContentsResponse|error

Sample code:

ListCompetencyContentsResponse result = check client->listCompetencyContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {},
        "roleNav": {}
      }
    ]
  }
}

createCompetencyContent

Creates a new CompetencyContent entity from the supplied payload.

Parameters:

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

Returns: CreatedCompetencyContent|error

Sample code:

CreatedCompetencyContent result = check client->createCompetencyContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    },
    "roleNav": {
      "externalCode": "1000",
      "familyNav": {},
      "jobCodeMappings": {},
      "roleCompetencyBehaviorMappings": {},
      "roleCompetencyMappings": {},
      "roleSkillMappings": {},
      "roleTalentPoolMappings": {}
    }
  }
}

getCompetencyContent

Retrieves a single CompetencyContent entity identified by its key properties.

Parameters:

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

Returns: CompetencyContent_1|error

Sample code:

CompetencyContent_1 result = check client->getCompetencyContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000",
      "behaviors": {},
      "competencies": {},
      "competencyTypes": {}
    },
    "roleNav": {
      "externalCode": "1000",
      "familyNav": {},
      "jobCodeMappings": {},
      "roleCompetencyBehaviorMappings": {},
      "roleCompetencyMappings": {},
      "roleSkillMappings": {},
      "roleTalentPoolMappings": {}
    }
  }
}

updateCompetencyContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateCompetencyContent(JobProfile_externalCode, externalCode, payload);

deleteCompetencyContent

Deletes the CompetencyContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteCompetencyContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCompetencyContent(JobProfile_externalCode, externalCode);

RelevantIndustryEntity

listRelevantIndustryEntities

Queries the RelevantIndustryEntity 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	ListRelevantIndustryEntitiesQueries	No	Queries to be sent with the request

Returns: ListRelevantIndustryEntitiesResponse|error

Sample code:

ListRelevantIndustryEntitiesResponse result = check client->listRelevantIndustryEntities();

Sample response:

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

createRelevantIndustryEntity

Creates a new RelevantIndustryEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRelevantIndustryEntity|error

Sample code:

CreatedRelevantIndustryEntity result = check client->createRelevantIndustryEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getRelevantIndustryEntity

Retrieves a single RelevantIndustryEntity entity identified by its key property.

Parameters:

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

Returns: RelevantIndustryEntity_1|error

Sample code:

RelevantIndustryEntity_1 result = check client->getRelevantIndustryEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateRelevantIndustryEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRelevantIndustryEntity(externalCode, payload);

deleteRelevantIndustryEntity

Deletes the RelevantIndustryEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteRelevantIndustryEntity(externalCode);

RoleTalentPoolMappingEntity

listRoleTalentPoolMappingEntities

Queries the RoleTalentPoolMappingEntity 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	ListRoleTalentPoolMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListRoleTalentPoolMappingEntitiesResponse|error

Sample code:

ListRoleTalentPoolMappingEntitiesResponse result = check client->listRoleTalentPoolMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "RoleEntity_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createRoleTalentPoolMappingEntity

Creates a new RoleTalentPoolMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedRoleTalentPoolMappingEntity|error

Sample code:

CreatedRoleTalentPoolMappingEntity result = check client->createRoleTalentPoolMappingEntity(payload);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getRoleTalentPoolMappingEntity

Retrieves a single RoleTalentPoolMappingEntity entity identified by its key properties.

Parameters:

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

Returns: RoleTalentPoolMappingEntity_1|error

Sample code:

RoleTalentPoolMappingEntity_1 result = check client->getRoleTalentPoolMappingEntity(RoleEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "RoleEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateRoleTalentPoolMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRoleTalentPoolMappingEntity(RoleEntity_externalCode, externalCode, payload);

deleteRoleTalentPoolMappingEntity

Deletes the RoleTalentPoolMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
RoleEntity_externalCode	string	Yes	key: RoleEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRoleTalentPoolMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRoleTalentPoolMappingEntity(RoleEntity_externalCode, externalCode);

EmploymentConditionEntity

listEmploymentConditionEntities

Queries the EmploymentConditionEntity 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	ListEmploymentConditionEntitiesQueries	No	Queries to be sent with the request

Returns: ListEmploymentConditionEntitiesResponse|error

Sample code:

ListEmploymentConditionEntitiesResponse result = check client->listEmploymentConditionEntities();

Sample response:

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

createEmploymentConditionEntity

Creates a new EmploymentConditionEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedEmploymentConditionEntity|error

Sample code:

CreatedEmploymentConditionEntity result = check client->createEmploymentConditionEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getEmploymentConditionEntity

Retrieves a single EmploymentConditionEntity entity identified by its key property.

Parameters:

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

Returns: EmploymentConditionEntity_1|error

Sample code:

EmploymentConditionEntity_1 result = check client->getEmploymentConditionEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateEmploymentConditionEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updateEmploymentConditionEntity(externalCode, payload);

deleteEmploymentConditionEntity

Deletes the EmploymentConditionEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteEmploymentConditionEntity(externalCode);

JobDescSection

listJobDescSections

Queries the JobDescSection 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	ListJobDescSectionsQueries	No	Queries to be sent with the request

Returns: ListJobDescSectionsResponse|error

Sample code:

ListJobDescSectionsResponse result = check client->listJobDescSections();

Sample response:

{
  "d": {
    "results": [
      {
        "JobDescTemplate_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobDescSection

Creates a new JobDescSection entity from the supplied payload.

Parameters:

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

Returns: CreatedJobDescSection|error

Sample code:

CreatedJobDescSection result = check client->createJobDescSection(payload);

Sample response:

{
  "d": {
    "JobDescTemplate_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobDescSection

Retrieves a single JobDescSection entity identified by its key properties.

Parameters:

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

Returns: JobDescSection_1|error

Sample code:

JobDescSection_1 result = check client->getJobDescSection(JobDescTemplate_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobDescTemplate_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateJobDescSection

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

Parameters:

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

Returns: error?

Sample code:

check client->updateJobDescSection(JobDescTemplate_externalCode, externalCode, payload);

deleteJobDescSection

Deletes the JobDescSection identified by its key properties.

Parameters:

Name	Type	Required	Description
JobDescTemplate_externalCode	string	Yes	key: JobDescTemplate_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteJobDescSectionHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobDescSection(JobDescTemplate_externalCode, externalCode);

RelevantIndustryContent

listRelevantIndustryContents

Queries the RelevantIndustryContent 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	ListRelevantIndustryContentsQueries	No	Queries to be sent with the request

Returns: ListRelevantIndustryContentsResponse|error

Sample code:

ListRelevantIndustryContentsResponse result = check client->listRelevantIndustryContents();

Sample response:

{
  "d": {
    "results": [
      {
        "JobProfile_externalCode": "1000",
        "externalCode": "1000",
        "entityNav": {}
      }
    ]
  }
}

createRelevantIndustryContent

Creates a new RelevantIndustryContent entity from the supplied payload.

Parameters:

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

Returns: CreatedRelevantIndustryContent|error

Sample code:

CreatedRelevantIndustryContent result = check client->createRelevantIndustryContent(payload);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

getRelevantIndustryContent

Retrieves a single RelevantIndustryContent entity identified by its key properties.

Parameters:

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

Returns: RelevantIndustryContent_1|error

Sample code:

RelevantIndustryContent_1 result = check client->getRelevantIndustryContent(JobProfile_externalCode, externalCode);

Sample response:

{
  "d": {
    "JobProfile_externalCode": "1000",
    "externalCode": "1000",
    "entityNav": {
      "externalCode": "1000"
    }
  }
}

updateRelevantIndustryContent

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

Parameters:

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

Returns: error?

Sample code:

check client->updateRelevantIndustryContent(JobProfile_externalCode, externalCode, payload);

deleteRelevantIndustryContent

Deletes the RelevantIndustryContent identified by its key properties.

Parameters:

Name	Type	Required	Description
JobProfile_externalCode	string	Yes	key: JobProfile_externalCode
externalCode	string	Yes	key: externalCode
headers	DeleteRelevantIndustryContentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteRelevantIndustryContent(JobProfile_externalCode, externalCode);

PositionEntity

listPositionEntities

Queries the PositionEntity 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	ListPositionEntitiesQueries	No	Queries to be sent with the request

Returns: ListPositionEntitiesResponse|error

Sample code:

ListPositionEntitiesResponse result = check client->listPositionEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "positionCompetencyMappings": {},
        "positionSkillMappings": {}
      }
    ]
  }
}

createPositionEntity

Creates a new PositionEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedPositionEntity|error

Sample code:

CreatedPositionEntity result = check client->createPositionEntity(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "positionCompetencyMappings": {
      "results": []
    },
    "positionSkillMappings": {
      "results": []
    }
  }
}

getPositionEntity

Retrieves a single PositionEntity entity identified by its key property.

Parameters:

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

Returns: PositionEntity_1|error

Sample code:

PositionEntity_1 result = check client->getPositionEntity(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "positionCompetencyMappings": {
      "results": []
    },
    "positionSkillMappings": {
      "results": []
    }
  }
}

updatePositionEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePositionEntity(externalCode, payload);

deletePositionEntity

Deletes the PositionEntity identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deletePositionEntity(externalCode);

PositionCompetencyMappingEntity

listPositionCompetencyMappingEntities

Queries the PositionCompetencyMappingEntity 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	ListPositionCompetencyMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListPositionCompetencyMappingEntitiesResponse|error

Sample code:

ListPositionCompetencyMappingEntitiesResponse result = check client->listPositionCompetencyMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "PositionEntity_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createPositionCompetencyMappingEntity

Creates a new PositionCompetencyMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedPositionCompetencyMappingEntity|error

Sample code:

CreatedPositionCompetencyMappingEntity result = check client->createPositionCompetencyMappingEntity(payload);

Sample response:

{
  "d": {
    "PositionEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getPositionCompetencyMappingEntity

Retrieves a single PositionCompetencyMappingEntity entity identified by its key properties.

Parameters:

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

Returns: PositionCompetencyMappingEntity_1|error

Sample code:

PositionCompetencyMappingEntity_1 result = check client->getPositionCompetencyMappingEntity(PositionEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "PositionEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

updatePositionCompetencyMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePositionCompetencyMappingEntity(PositionEntity_externalCode, externalCode, payload);

deletePositionCompetencyMappingEntity

Deletes the PositionCompetencyMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
PositionEntity_externalCode	string	Yes	key: PositionEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeletePositionCompetencyMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePositionCompetencyMappingEntity(PositionEntity_externalCode, externalCode);

PositionSkillMappingEntity

listPositionSkillMappingEntities

Queries the PositionSkillMappingEntity 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	ListPositionSkillMappingEntitiesQueries	No	Queries to be sent with the request

Returns: ListPositionSkillMappingEntitiesResponse|error

Sample code:

ListPositionSkillMappingEntitiesResponse result = check client->listPositionSkillMappingEntities();

Sample response:

{
  "d": {
    "results": [
      {
        "PositionEntity_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createPositionSkillMappingEntity

Creates a new PositionSkillMappingEntity entity from the supplied payload.

Parameters:

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

Returns: CreatedPositionSkillMappingEntity|error

Sample code:

CreatedPositionSkillMappingEntity result = check client->createPositionSkillMappingEntity(payload);

Sample response:

{
  "d": {
    "PositionEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getPositionSkillMappingEntity

Retrieves a single PositionSkillMappingEntity entity identified by its key properties.

Parameters:

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

Returns: PositionSkillMappingEntity_1|error

Sample code:

PositionSkillMappingEntity_1 result = check client->getPositionSkillMappingEntity(PositionEntity_externalCode, externalCode);

Sample response:

{
  "d": {
    "PositionEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

updatePositionSkillMappingEntity

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePositionSkillMappingEntity(PositionEntity_externalCode, externalCode, payload);

deletePositionSkillMappingEntity

Deletes the PositionSkillMappingEntity identified by its key properties.

Parameters:

Name	Type	Required	Description
PositionEntity_externalCode	string	Yes	key: PositionEntity_externalCode
externalCode	string	Yes	key: externalCode
headers	DeletePositionSkillMappingEntityHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePositionSkillMappingEntity(PositionEntity_externalCode, externalCode);