Incentive Compensation Management

Live

Incentive Compensation Management

+ Day(s) remaining in the trial

Overview

This IBM Incentive Compensation Management API allows you to develop integrated applications.

The API allows Incentive Compensation Management modules to be available or linked into an existing program to complete the required tasks. The API uses HTTP verbs and a RESTful endpoint structure. Request and response payloads are formatted as JSON.

The intent of this API section is to provide client organizations that want to access Incentive Compensation Management in a programmatic way with an interoperable option. Some common uses include the following scenarios:

  • Client organizations that want to retrieve calculated or statistical data from Incentive Compensation Management for use in other downstream applications, such as portal applications, reporting, or other systems.
  • Client organizations that want to leverage web services to more tightly integrate systems.
  • Client organizations that want to programatically trigger Incentive Compensation Management with existing third-party scheduling or application management software.
  • Partner ogranizations that want to integrate their solution more closely with Incentive Compensation Management.

The previous scenarios involve querying Incentive Compensation Management, retrieving data from the system, updating data within the system, and adding data to the system.


'

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Incentive Compensation Management:

Activity

Live and completed activities
CompletedActivitiesControllerV1_Delete

DELETE   /api/v1/completedactivities/{id}

			https://localhost//api/v1/completedactivities/{id}
		
Keys
Path and Query parameters

id

URL , required

Request code
								
HttpResponse<String> response = Unirest.delete("https://localhost:31287/api/v1/completedactivities/{id}") .header("accept", "application/json") .asString();
Response model

200

OK

Response example

200

OK

CompletedActivitiesControllerV1_DeleteAllFinished

DELETE   /api/v1/completedactivities

			https://localhost//api/v1/completedactivities
		
Keys
Request code
								
HttpResponse<String> response = Unirest.delete("https://localhost:31287/api/v1/completedactivities") .header("accept", "application/json") .asString();
Response model

200

OK

Response example

200

OK

CompletedActivitiesControllerV1_Post

POST   /api/v1/completedactivities

			https://localhost//api/v1/completedactivities
		
Keys
Request code
								
HttpResponse<String> response = Unirest.post("https://localhost:31287/api/v1/completedactivities") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Request model

message

STRING , optional

messageDetails

STRING , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Request example
{
  "message": string,
  "messageDetails": string,
  "progressId": integer,
  "status": [Running, Completed, Failed, Cancelled],
  "time": string,
  "type": [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId": string
}
Response model

200

OK

Response example

200

OK

Get completed activities.
###Response Headers **Link**: Links to first, next, and last page **totalRows**: Total number of rows

GET   /api/v1/completedactivities

			https://localhost//api/v1/completedactivities
		
Keys
Path and Query parameters

filter

STRING , optional

####Supported operations - Equal matching; `name=admin` - Note that this type of matching is *Strictly equal* and case sensitive - Starts by; `name^admi` - Case-*un*sensitive - Ends with; `name$min` - Case-*un*sensitive - Equal matching within a list, aka *in*; `userType=Admin\,Web` - Interval marching; `date=[2015-09-22\,2015-09-25]` - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka `[a\,b]`, `(a\,b)` or a mix `(a\,b]` - Intervals also support open-ended bounds, i.e. `(a\,]` - Not equal matching; `name<>admin` - Strict, case-sensitive comparison. - Is contained in; `name?dmi` - Case-*un*sensitive - NULL checks; `name=NULL` or `name<>NULL` - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered *must* be the same both sides of the operator. Supported operators are: - AND `&&` - OR `||` ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the `;` symbol to separate the various filter statements. ####Supported Fields type, time, status, progressid

limit

INTEGER , optional

Number of records to retrieve. **Default**: 50

offset

INTEGER , optional

Offset number of records. Returns status code 500 if offset exceeds total number of records. **Default**: none

orderBy

STRING , optional

####Description OrderBy provides sorting by column (multiple columns supported, comma delimited). ####Syntax Direction: + (ascending), - (descending) Column: name ####Example orderBy=-date ####Supported Fields time

Request code
								
HttpResponse<String> response = Unirest.get("https://localhost:31287/api/v1/completedactivities?filter=string&orderBy=string&limit=0&offset=0") .header("accept", "application/json") .asString();
Response model

200

OK

Body

message

STRING , optional

messageDetails

STRING , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Response example

200

OK

								[{
  "message" : string,
  "messageDetails" : string,
  "progressId" : integer,
  "status" : [Running, Completed, Failed, Cancelled],
  "time" : string,
  "type" : [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId" : string
}]
							
Get completed activity by ID.

GET   /api/v1/completedactivities/{id}

			https://localhost//api/v1/completedactivities/{id}
		
Keys
Path and Query parameters

id

URL , required

Id

Request code
								
HttpResponse<String> response = Unirest.get("https://localhost:31287/api/v1/completedactivities/{id}") .header("accept", "application/json") .asString();
Response model

200

OK

Body

message

STRING , optional

messageDetails

STRING , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Response example

200

OK

								{
  "message" : string,
  "messageDetails" : string,
  "progressId" : integer,
  "status" : [Running, Completed, Failed, Cancelled],
  "time" : string,
  "type" : [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId" : string
}
							
Get live activities.
###Response Headers **Link**: Links to first, next, and last page **totalRows**: Total number of rows

GET   /api/v1/liveactivities

			https://localhost//api/v1/liveactivities
		
Keys
Path and Query parameters

filter

STRING , optional

####Supported operations - Equal matching; `name=admin` - Note that this type of matching is *Strictly equal* and case sensitive - Starts by; `name^admi` - Case-*un*sensitive - Ends with; `name$min` - Case-*un*sensitive - Equal matching within a list, aka *in*; `userType=Admin\,Web` - Interval marching; `date=[2015-09-22\,2015-09-25]` - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka `[a\,b]`, `(a\,b)` or a mix `(a\,b]` - Intervals also support open-ended bounds, i.e. `(a\,]` - Not equal matching; `name<>admin` - Strict, case-sensitive comparison. - Is contained in; `name?dmi` - Case-*un*sensitive - NULL checks; `name=NULL` or `name<>NULL` - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered *must* be the same both sides of the operator. Supported operators are: - AND `&&` - OR `||` ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the `;` symbol to separate the various filter statements. ####Supported Fields type, time, status, progressid

limit

INTEGER , optional

Number of records to retrieve. **Default**: 50

offset

INTEGER , optional

Offset number of records. Returns status code 500 if offset exceeds total number of records. **Default**: 0

orderBy

STRING , optional

####Description OrderBy provides sorting by column (multiple columns supported, comma delimited). ####Syntax Direction: + (ascending), - (descending) Column: name ####Example orderBy=-date ####Supported Fields time

Request code
								
HttpResponse<String> response = Unirest.get("https://localhost:31287/api/v1/liveactivities?filter=string&orderBy=string&limit=0&offset=0") .header("accept", "application/json") .asString();
Response model

200

OK

Body

description

STRING , optional

hasDescription

BOOLEAN , optional

isCancellable

BOOLEAN , optional

message

STRING , optional

messageDetails

STRING , optional

percent

INTEGER , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Response example

200

OK

								[{
  "description" : string,
  "hasDescription" : boolean,
  "isCancellable" : boolean,
  "message" : string,
  "messageDetails" : string,
  "percent" : integer,
  "progressId" : integer,
  "status" : [Running, Completed, Failed, Cancelled],
  "time" : string,
  "type" : [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId" : string
}]
							
LiveActivitiesControllerV1_Get

GET   /api/v1/liveactivities/{id}

			https://localhost//api/v1/liveactivities/{id}
		
Keys
Path and Query parameters

id

URL , required

Request code
								
HttpResponse<String> response = Unirest.get("https://localhost:31287/api/v1/liveactivities/{id}") .header("accept", "application/json") .asString();
Response model

200

OK

Body

description

STRING , optional

hasDescription

BOOLEAN , optional

isCancellable

BOOLEAN , optional

message

STRING , optional

messageDetails

STRING , optional

percent

INTEGER , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Response example

200

OK

								{
  "description" : string,
  "hasDescription" : boolean,
  "isCancellable" : boolean,
  "message" : string,
  "messageDetails" : string,
  "percent" : integer,
  "progressId" : integer,
  "status" : [Running, Completed, Failed, Cancelled],
  "time" : string,
  "type" : [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId" : string
}
							
Update a live activity by ID.

PUT   /api/v1/liveactivities/{id}

			https://localhost//api/v1/liveactivities/{id}
		
Keys
Path and Query parameters

id

URL , required

Request code
								
HttpResponse<String> response = Unirest.put("https://localhost:31287/api/v1/liveactivities/{id}") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Request model

description

STRING , optional

hasDescription

BOOLEAN , optional

isCancellable

BOOLEAN , optional

message

STRING , optional

messageDetails

STRING , optional

percent

INTEGER , optional

progressId

INTEGER , optional

status

STRING , optional

time

STRING , optional

type

STRING , optional

userId

STRING , optional

Request example
{
  "description": string,
  "hasDescription": boolean,
  "isCancellable": boolean,
  "message": string,
  "messageDetails": string,
  "percent": integer,
  "progressId": integer,
  "status": [Running, Completed, Failed, Cancelled],
  "time": string,
  "type": [Calculation, Import, Library, Migration, Task, Time, Optimization, Preview, AssignTableSynchronization, BPMWorkflow, PurgePeriods, PLCMSync, MakeEffective, Watson, Publication, Transformation, Scheduler, ScenarioPromote, NotifyUsers, HistoryPurge, TQM, PushAnalyticsData, ReapplyTemplate, UpdateHistoryTracking, ModifyCalendar, TableClear],
  "userId": string
}
Response model

200

OK

400

Activity not cancellable, or status not set to Cancelled

Response example

200

OK

400

Activity not cancellable, or status not set to Cancelled

Loading content...

Resources