# KSX API

OpenAPI specification for Kantata SX.

Version: 1.0.0

## Servers

```
/services/apexrest/KSX/
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[KSX API](https://kantata-sx-api.redocly.app/_bundle/openapi-3.1.yaml)

## Activity Assignments

### List and retrieve Activity Assignments

 - [GET /api/activity-assignments](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/list_or_search_activity_assignments.md): Return a filtered, paginated list of Activity Assignments

### Create Activity Assignment

 - [POST /api/activity-assignments](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/create_new_activity_assignment.md): Create Activity Assignment

### Retrieve a specific Activity Assignment by Id

 - [GET /api/activity-assignments/{activityAssignmentId}](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/get_activity_assignment_details_by_id.md): Return a specific Activity Assignment by Id

### Update an Activity Assignment

 - [PATCH /api/activity-assignments/{activityAssignmentId}](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/update_activity_assignment.md): Update an Activity Assignment

### Delete an Activity Assignment

 - [DELETE /api/activity-assignments/{activityAssignmentId}](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/delete_activity_assignment.md): Delete an Activity Assignment

### Clone an Activity Assignment

 - [POST /api/activity-assignments/{activityAssignmentId}/clone](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/clone_activity_assignment.md): Clone an Activity Assignment

### Snip an Activity Assignment

 - [POST /api/activity-assignments/{activityAssignmentId}/snip](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/snip_activity_assignment.md): Snip an Activity Assignment

### Get Activity Assignment Usage

 - [GET /api/activity-assignments/{activityAssignmentId}/usage](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/get_assignment_usage.md): Get Activity Assignment Usage

### Update Usages for an Activity Assignment

 - [PATCH /api/activity-assignments/{activityAssignmentId}/usage](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/update_assignment_usage.md): Update Usages for an Activity Assignment

### Remove Forecast Usage for an Activity Assignment

 - [PATCH /api/activity-assignments/{activityAssignmentId}/removeForecast](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/remove_assignment_usage.md): Remove Forecast Usage for an Activity Assignment

### List the Required Capabilities for an Activity Assignment

 - [GET /api/activity-assignments/{activityAssignmentId}/requiredCapabilities](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/get_assignment_required_capabilities.md): Return a filtered, paginated list of Required Capabilities for an Activity Assignment

### Get Activity Assignment Config

 - [GET /api/activity-assignments/{activityAssignmentId}/config](https://kantata-sx-api.redocly.app/openapi-3.1/activity-assignments/get_assignment_config.md): Get Activity Assignment Configuration / allowed actions

## Activity Roles

### List and retrieve Activity Roles

 - [GET /api/activity-roles](https://kantata-sx-api.redocly.app/openapi-3.1/activity-roles/list_or_search_activity_roles.md): Return a filtered, paginated list of Activity Roles

### Retrieve a specific Activity Role by Id

 - [GET /api/activity-roles/{activityRoleId}](https://kantata-sx-api.redocly.app/openapi-3.1/activity-roles/get_activity_role_details_by_id.md): Return a specific Activity Role by Id

## Business Units

### List and retrieve business units. This endpoint manages operating business units only.

 - [GET /api/business-units](https://kantata-sx-api.redocly.app/openapi-3.1/business-units/list_or_search_business_units.md): Return a filtered, paginated list of Business Units

### Retrieve a specific Business Unit by Id

 - [GET /api/business-unit/{businessUnitId}](https://kantata-sx-api.redocly.app/openapi-3.1/business-units/get_business_unit_details_by_id.md): Return a specific Business Unit by Id

## Delivery Engagements

### List and retrieve Delivery Engagements

 - [GET /api/engagements](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-engagements/list_or_search_engagements.md): Return a filtered, paginated list of Delivery Engagements

### Retrieve a specific Delivery Engagement by Id

 - [GET /api/engagements/{engagementId}](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-engagements/get_engagement_details_by_id.md): Return a specific Delivery Engagement

### List and retrieve Delivery Elements for a specific Delivery Engagement

 - [GET /api/engagements/{engagementId}/elements](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-engagements/get_engagement_elements.md): Return a filtered, paginated list of Delivery Elements for a specific Delivery Engagement

### List and retrieve Delivery Stages for a specific Delivery Engagement

 - [GET /api/engagements/{engagementId}/stages](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-engagements/get_engagement_delivery_stages.md): Return a filtered, paginated list of Delivery Stages for a specific Delivery Engagement

### Change the Delivery Stage of the specified Engagement

 - [PATCH /api/engagements/{engagementId}/stages](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-engagements/engagement_stage_update.md): Change the Delivery Stage of the specified Engagement

## Delivery Stages

### List and retrieve Delivery Stages

 - [GET /api/delivery-stages](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-stages/delivery_stages_list.md): Return a filtered, paginated list of Delivery Stages

### Retrieve a specific Delivery Stage by Id

 - [GET /api/delivery-stages/{deliveryStageId}](https://kantata-sx-api.redocly.app/openapi-3.1/delivery-stages/get_delivery_stage_details_by_id.md): Return a specific Delivery Stage by Id

## Grades

### List and retrieve Grades

 - [GET /api/grades](https://kantata-sx-api.redocly.app/openapi-3.1/grades/list_or_search_grades.md): Return a filtered, paginated list of Grades

### Retrieve a specific Grade by Id

 - [GET /api/grades/{gradeId}](https://kantata-sx-api.redocly.app/openapi-3.1/grades/get_grade_details_by_id.md): Return a specific Grade by Id

## Jobs

### Get Job data for a given context

 - [GET /api/jobs](https://kantata-sx-api.redocly.app/openapi-3.1/jobs/jobs_list.md): Get Job data for a given context

## Locations

### List and retrieve Locations

 - [GET /api/locations](https://kantata-sx-api.redocly.app/openapi-3.1/locations/list_or_search_locations.md): Return a filtered, paginated list of Locations

### Retrieve a specific Location by Id

 - [GET /api/locations/{locationId}](https://kantata-sx-api.redocly.app/openapi-3.1/locations/get_location_details_by_id.md): Return a specific Location by Id

## Resources

### List and retrieve Resources

 - [GET /api/resources](https://kantata-sx-api.redocly.app/openapi-3.1/resources/list_or_search_resources.md): Return a filtered, paginated list of Resources

### Retrieve a specific Resource by Id

 - [GET /api/resources/{resourceId}](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_details_get.md): Return a specific Resource by Id

### List and retrieve Activity Roles for a specific Resource

 - [GET /api/resources/{resourceId}/activityRoles](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_activity_roles_get.md): Return a filtered, paginated list of Activity Roles for the specified Resource

### List and retrieve Resource Capabilities for a specific Resource

 - [GET /api/resources/{resourceId}/capabilities](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_capabilities_get.md): Return a filtered, paginated list of Resource Capabilities for the specified Resource

### List and retrieve assignment Resource Experience for a specific Resource

 - [GET /api/resources/{resourceId}/assignmentExperience](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_assignment_experience_get.md): Return a filtered, paginated list of assignment Resource Experience for the specified Resource

### List and retrieve other Resource Experience for a specific Resource

 - [GET /api/resources/{resourceId}/otherExperience](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_other_experience_get.md): Return a filtered, paginated list of other Resource Experience for the specified Resource

### Generate a PDF and attach it to the specified resource, using the html provided in the request

 - [POST /api/resources/{resourceId}/generatePdf](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_pdf_generate_and_attach.md): Generates a PDF document from provided HTML content and attaches it to the specified Resource (person, employee, or team). Used for creating custom documents like CVs or profile summaries.

### Create a file and attach it to the specified resource, using the raw content provided in the request

 - [POST /api/resources/{resourceId}/files](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_create_file.md): Creates a Salesforce File from provided content and attaches it to the specified Resource (person, employee, or team).

### Get Resource Availability

 - [GET /api/resources/{resourceId}/availability](https://kantata-sx-api.redocly.app/openapi-3.1/resources/resource_availability_get.md): Get Resource Availability

## Resource Types

### List and retrieve resource-types. This only returns assignable resource types.

 - [GET /api/resource-types](https://kantata-sx-api.redocly.app/openapi-3.1/resource-types/list_or_search_resource_types.md): Return a filtered, paginated list of Resource Types

### Retrieve a specific Resource Type by Id

 - [GET /api/resource-types/{resourceTypeId}](https://kantata-sx-api.redocly.app/openapi-3.1/resource-types/get_resource_type_details_by_id.md): Return a specific Resource Type by Id

## Other Resourced Activities

### List and retrieve Other Resourced Activities

 - [GET /api/other-resourced-activities](https://kantata-sx-api.redocly.app/openapi-3.1/other-resourced-activities/other_resourced_activities_list.md): Return a filtered, paginated list of Other Resourced Activities

### Retrieve a specific Other Resourced Activity by Id

 - [GET /api/other-resourced-activities/{otherResourcedActivityId}](https://kantata-sx-api.redocly.app/openapi-3.1/other-resourced-activities/other_resourced_activity_details_get.md): Return a specific Other Resourced Activity by Id

## Usage Behaviour Rules

### List and retrieve Usage Behaviour Rules

 - [GET /api/usage-behaviour-rules](https://kantata-sx-api.redocly.app/openapi-3.1/usage-behaviour-rules/list_or_search_usage_behaviour_rules.md): Return a filtered, paginated list of Usage Behaviour Rules

### Retrieve a specific Usage Behaviour Rule by Id

 - [GET /api/usage-behaviour-rules/{usageBehaviourRuleId}](https://kantata-sx-api.redocly.app/openapi-3.1/usage-behaviour-rules/get_usage_behaviour_rule_details_by_id.md): Return a specific Usage Behaviour Rule by Id