Mijn Communities
Help

IAM other endpoints

20-12-2021 15:27 (Bijgewerkt op 06-11-2023)
  • 0 Antwoorden
  • 0 kudos
  • 1625 Weergaven

Swagger documentation

The following swagger pages gives an overview of the endpoint:

 

Filters

Person endpoint

The person endpoint supports the following query string parameters

Parameter

Description

from and to 

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) person records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/persons?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

 

Employee endpoint

 

THIS ENDPOINT HAS BEEN DEPRECATED
Use the endpoints Person and Employment.

 

The employee endpoint supports the following query string parameters

Parameter

Description

personCode 

 

Returns a list of employee records filtered by personId

https://api.youforce.com/iam/v1.0/employees?personCode=191166

personId

Returns a list of employee records filtered by personId

https://api.youforce.com/iam/v1.0/employees?personId=191166

 

organizationUnit

Returns a list of all employee records filtered by organizationUnit id

https://api.youforce.com/iam/v1.0/employees?

organizationUnit=13612345

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) employee records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/employees?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

Employment endpoint

The employee endpoint supports the following query string parameters

Parameter

Description

personCode

 

Returns a list of employment records filtered by personId

https://api.youforce.com/iam/v1.0/employments?personCode=191166

personId

Returns a list of employment records filtered by personId

https://api.youforce.com/iam/v1.0/employments?personId=191166

organizationUnit

Returns a list of all employment records filtered by organizationUnit id

https://api.youforce.com/iam/v1.0/employments?

organizationUnit=13612345

 

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) employment records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/employments?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

Assignment endpoint

The assignments endpoint supports the following query string parameters

 

Parameter

Description

personId

Returns a list of assignment records filtered by personId

https://api.youforce.com/iam/v1.0/assignments?personId=191166

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) assignment records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/assignments?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

Cost allocation endpoint

The cost allocation endpoint supports the following query string parameters

 

Parameter

Description

 

Id

Returns the cost allocation by id

https://api.youforce.com/iam/v1.0/costAllocations/100028%201%200

 

Person code

Returns a list of cost allocations for a specific person. The list could contain records for different employments of the employee

https://api.youforce.com/iam/v1.0/costAllocations?personCode=100028

 

 

Organization unit endpoint

The organizationUnits endpoint supports the following query string parameters

Parameter

Description

shortName

Returns a list of all organizationUnit records filtered by shortName

https://api.youforce.com/iam/v1.0/organizationUnits?company=1010A

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) organization unit records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/organizationUnits?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

Role assignment endpoint

The roleAssignments endpoint supports the following query string parameters

 

 

Parameter

Description

personId

Returns a list of all role assignment records filtered by personId

https://api.youforce.com/iam/v1.0/roleAssignments?personId=1010A

shortName

Returns a list of all role assignment records filtered by shortName

https://api.youforce.com/iam/v1.0/roleAssignments?shortName=MGR

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) employee records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/roleAssignments?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z

 

Job profile endpoint

The jobProfiles endpoint supports the following query string parameters

Parameter

Description

shortName

Returns a list of all jobProfile records filtered by shortName

https://api.youforce.com/iam/v1.0/jobProfiles?shortName=1010A

from and to

Date Time stamp filter:

  • Date Time should be in UTC
    • Format: YYYY-MM-DDTHH:MM:SS.sssZ

Returns (active) jobProfile records that have changed within the provided date-time range.

https://api.youforce.com/iam/v1.0/jobProfiles?

from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z