Jump to

• Request
• Response
• Examples

Publish and export the candidate role to file

post

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/publish-offline

Publish the candidate role and export the candidate role to file

Request

Path Parameters

• candidateRoleId: string
• taskId: string

Query Parameters

• includeMembers(optional): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

OK

Body ()

Root Schema : schema

Type: string(binary)

Back to Top

Examples

The following example shows how to publish a candidate role and then export the candidate role to a file.

curl -X POST\
-H "Accept: application/octet-stream"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/11cc57a41eaf48dfab2758f3bc2ad570/candidate-roles/2c1edfd520e44cce8fadf04c4c8da4b2/publish-offline?includeMembers=true"

Example of the Response Body

The following is an example of the response body in JSON format.

Name,Description,User Count,Entitlement Count,Application Count,Total User Count,Total Entitlement Count
Sample Candidate Role,Ab_ Candidate Role for the Cluster : 1,1,9,1,1,9
""
""
CandidateRole - Users List
Ext User Id,User Name,Employee Type,Job Code,Manager Name,Organization Name,User Display Name,Manager Display Name,Employee Number,Department Number
39,PHEY,Full-Time,IC10004,SYSTEM_ADMIN,MyOrg1,Pat Huey,System Administrator,100059,QA
""
""
CandidateRole - Entitlements List
Ext Entitlement Id,Entitlement Display Name,Application Name
83,"CN=adbienta19,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
28,"CN=adbienta2,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
53,"CN=adbienta20,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
5,"CN=adbienta3,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
98,"CN=adbienta4,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
37,"CN=adbienta5,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
10,"CN=adbienta6,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
93,"CN=adbienta7001,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD
89,"CN=adbienta8,OU=grps,OU=robert_bi_test,DC=adlrg12c,DC=us,DC=example,DC=com",MyAD

Back to Top