### Tasks - Core - Activities - Activity Actions

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for performing actions on activities.

```APIDOC
## POST /api/activities/{activityId}/cancel

### Description
Cancels an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/cancel
```

```APIDOC
## POST /api/activities/{activityId}/enroute-to-pending

### Description
Changes the activity status from enroute to pending.

### Method
POST

### Endpoint
/api/activities/{activityId}/enroute-to-pending
```

```APIDOC
## POST /api/activities/{activityId}/complete

### Description
Completes an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/complete
```

```APIDOC
## POST /api/activities/{activityId}/delay

### Description
Delays an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/delay
```

```APIDOC
## DELETE /api/activities/{activityId}

### Description
Deletes an activity.

### Method
DELETE

### Endpoint
/api/activities/{activityId}
```

```APIDOC
## POST /api/activities/{activityId}/move

### Description
Moves an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/move
```

```APIDOC
## POST /api/activities/{activityId}/reopen

### Description
Reopens an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/reopen
```

```APIDOC
## POST /api/activities/{activityId}/start

### Description
Starts an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/start
```

```APIDOC
## POST /api/activities/{activityId}/start-prework

### Description
Starts the prework for an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/start-prework
```

```APIDOC
## POST /api/activities/{activityId}/suspend

### Description
Suspends an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/suspend
```

```APIDOC
## POST /api/activities/{activityId}/update-status-enroute

### Description
Updates the activity status to enroute.

### Method
POST

### Endpoint
/api/activities/{activityId}/update-status-enroute
```

```APIDOC
## POST /api/activities/{activityId}/update-status-notdone

### Description
Updates the activity status to notdone.

### Method
POST

### Endpoint
/api/activities/{activityId}/update-status-notdone
```

--------------------------------

### Tasks - Core - Activities - Activity File Properties

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing file properties of activities.

```APIDOC
## DELETE /api/activities/{activityId}/file-properties/{propertyId}

### Description
Deletes a file property for an activity.

### Method
DELETE

### Endpoint
/api/activities/{activityId}/file-properties/{propertyId}
```

```APIDOC
## GET /api/activities/{activityId}/file-properties/{propertyId}

### Description
Retrieves a specific file property of an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/file-properties/{propertyId}
```

```APIDOC
## POST /api/activities/{activityId}/file-properties

### Description
Sets a file property for an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/file-properties
```

--------------------------------

### Tasks - Core - Activities - Activity Resource Preferences

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resource preferences for activities.

```APIDOC
## DELETE /api/activities/{activityId}/resource-preferences

### Description
Deletes resource preferences for an activity.

### Method
DELETE

### Endpoint
/api/activities/{activityId}/resource-preferences
```

```APIDOC
## GET /api/activities/{activityId}/resource-preferences

### Description
Retrieves resource preferences for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/resource-preferences
```

```APIDOC
## POST /api/activities/{activityId}/resource-preferences

### Description
Sets resource preferences for an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/resource-preferences
```

--------------------------------

### Tasks - Core - Activities

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing activities.

```APIDOC
## POST /api/activities/bulk-update

### Description
Performs a bulk update on activities.

### Method
POST

### Endpoint
/api/activities/bulk-update
```

```APIDOC
## POST /api/activities

### Description
Creates a new activity.

### Method
POST

### Endpoint
/api/activities
```

```APIDOC
## GET /api/activities

### Description
Retrieves a list of activities.

### Method
GET

### Endpoint
/api/activities
```

```APIDOC
## GET /api/activities/{activityId}

### Description
Retrieves details of a specific activity.

### Method
GET

### Endpoint
/api/activities/{activityId}
```

```APIDOC
## GET /api/activities/{activityId}/capacity-categories

### Description
Retrieves capacity categories for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/capacity-categories
```

```APIDOC
## GET /api/activities/{activityId}/segments

### Description
Retrieves individual segments of a segmentable activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/segments
```

```APIDOC
## GET /api/activities/search

### Description
Searches for activities based on specified criteria.

### Method
GET

### Endpoint
/api/activities/search
```

```APIDOC
## PUT /api/activities/{activityId}

### Description
Updates an existing activity.

### Method
PUT

### Endpoint
/api/activities/{activityId}
```

```APIDOC
## GET /api/activities/technician-location

### Description
Determines the technician's location for an activity.

### Method
GET

### Endpoint
/api/activities/technician-location
```

--------------------------------

### Tasks - Core - Activities - Activity Links

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing links between activities.

```APIDOC
## POST /api/activities/{activityId}/links

### Description
Creates a link between activities.

### Method
POST

### Endpoint
/api/activities/{activityId}/links
```

```APIDOC
## DELETE /api/activities/{activityId}/links

### Description
Deletes all links associated with an activity.

### Method
DELETE

### Endpoint
/api/activities/{activityId}/links
```

```APIDOC
## DELETE /api/activities/{activityId}/links/{linkId}

### Description
Deletes a specific link between activities.

### Method
DELETE

### Endpoint
/api/activities/{activityId}/links/{linkId}
```

```APIDOC
## GET /api/activities/{activityId}/links/{linkId}

### Description
Retrieves details of a specific activity link.

### Method
GET

### Endpoint
/api/activities/{activityId}/links/{linkId}
```

```APIDOC
## GET /api/activities/{activityId}/links

### Description
Retrieves a list of activity links.

### Method
GET

### Endpoint
/api/activities/{activityId}/links
```

```APIDOC
## PUT /api/activities/{activityId}/links/{linkId}

### Description
Replaces an existing activity link.

### Method
PUT

### Endpoint
/api/activities/{activityId}/links/{linkId}
```

--------------------------------

### Metadata API - Plugins

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

APIs for managing plugins.

```APIDOC
## POST /api/metadata/plugins/import

### Description
Imports plugins.

### Method
POST

### Endpoint
/api/metadata/plugins/import

### Request Body
- **pluginData** (object) - Required - Data for the plugins to import.

### Request Example
{
  "pluginData": {
    "plugin1": "data1"
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Plugins imported successfully."
}
```

```APIDOC
## POST /api/metadata/plugins/installstandard

### Description
Installs a standard plugin.

### Method
POST

### Endpoint
/api/metadata/plugins/installstandard

### Request Body
- **pluginName** (string) - Required - The name of the standard plugin to install.

### Request Example
{
  "pluginName": "StandardReportingPlugin"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Standard plugin installed successfully."
}
```

--------------------------------

### Tasks - Core - Activities - Activity Inventories

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing customer inventories associated with activities.

```APIDOC
## POST /api/activities/{activityId}/inventories/customer

### Description
Creates a customer inventory for an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/inventories/customer
```

```APIDOC
## GET /api/activities/{activityId}/inventories/customer

### Description
Retrieves customer inventories for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/inventories/customer
```

```APIDOC
## GET /api/activities/{activityId}/inventories/deinstalled

### Description
Retrieves deinstalled inventories for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/inventories/deinstalled
```

```APIDOC
## GET /api/activities/{activityId}/inventories/installed

### Description
Retrieves installed inventories for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/inventories/installed
```

--------------------------------

### Tasks - Core - Activities - Activity Required Inventories

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing required inventories for activities.

```APIDOC
## DELETE /api/activities/{activityId}/required-inventories

### Description
Deletes required inventories for an activity.

### Method
DELETE

### Endpoint
/api/activities/{activityId}/required-inventories
```

```APIDOC
## GET /api/activities/{activityId}/required-inventories

### Description
Retrieves the required inventories for an activity.

### Method
GET

### Endpoint
/api/activities/{activityId}/required-inventories
```

```APIDOC
## POST /api/activities/{activityId}/required-inventories

### Description
Sets the required inventories for an activity.

### Method
POST

### Endpoint
/api/activities/{activityId}/required-inventories
```

--------------------------------

### Tasks - Core - Resources - Resource Work Plans

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing work plans for resources.

```APIDOC
## POST /api/resources/{resourceId}/work-plans

### Description
Creates a work plan for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/work-plans
```

```APIDOC
## DELETE /api/resources/{resourceId}/work-plans/{planId}

### Description
Deletes a work plan for a resource.

### Method
DELETE

### Endpoint
/api/resources/{resourceId}/work-plans/{planId}
```

```APIDOC
## GET /api/resources/{resourceId}/work-plans

### Description
Retrieves work plans for a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/work-plans
```

--------------------------------

### Tasks - Core - Resources - Resource Routes

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resource routes.

```APIDOC
## POST /api/resources/{resourceId}/routes/activate

### Description
Activates a resource route.

### Method
POST

### Endpoint
/api/resources/{resourceId}/routes/activate
```

```APIDOC
## POST /api/resources/{resourceId}/routes/deactivate

### Description
Deactivates a resource route.

### Method
POST

### Endpoint
/api/resources/{resourceId}/routes/deactivate
```

```APIDOC
## GET /api/resources/{resourceId}/routes/{routeId}

### Description
Retrieves details of a specific resource route.

### Method
GET

### Endpoint
/api/resources/{resourceId}/routes/{routeId}
```

--------------------------------

### Tasks - Core - Inventories

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing inventories.

```APIDOC
## POST /api/inventories

### Description
Creates new inventories.

### Method
POST

### Endpoint
/api/inventories
```

```APIDOC
## POST /api/inventories/deinstall

### Description
Deinstalls an inventory.

### Method
POST

### Endpoint
/api/inventories/deinstall
```

```APIDOC
## DELETE /api/inventories/{inventoryId}/file-properties/{propertyId}

### Description
Deletes a file property for an inventory.

### Method
DELETE

### Endpoint
/api/inventories/{inventoryId}/file-properties/{propertyId}
```

```APIDOC
## DELETE /api/inventories/{inventoryId}

### Description
Deletes an inventory.

### Method
DELETE

### Endpoint
/api/inventories/{inventoryId}
```

```APIDOC
## GET /api/inventories/{inventoryId}/file-properties/{propertyId}

### Description
Retrieves a specific file property of an inventory.

### Method
GET

### Endpoint
/api/inventories/{inventoryId}/file-properties/{propertyId}
```

```APIDOC
## GET /api/inventories/{inventoryId}

### Description
Retrieves details of a specific inventory.

### Method
GET

### Endpoint
/api/inventories/{inventoryId}
```

```APIDOC
## POST /api/inventories/install

### Description
Installs an inventory.

### Method
POST

### Endpoint
/api/inventories/install
```

```APIDOC
## POST /api/inventories/{inventoryId}/file-properties

### Description
Sets a file property for an inventory.

### Method
POST

### Endpoint
/api/inventories/{inventoryId}/file-properties
```

```APIDOC
## POST /api/inventories/undo-deinstall

### Description
Undoes the deinstallation of an inventory.

### Method
POST

### Endpoint
/api/inventories/undo-deinstall
```

```APIDOC
## POST /api/inventories/undo-install

### Description
Undoes the installation of an inventory.

### Method
POST

### Endpoint
/api/inventories/undo-install
```

```APIDOC
## PUT /api/inventories/{inventoryId}

### Description
Updates an existing inventory.

### Method
PUT

### Endpoint
/api/inventories/{inventoryId}
```

--------------------------------

### Tasks - Core - Resources - Resource File Properties

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing file properties of resources.

```APIDOC
## DELETE /api/resources/{resourceId}/file-properties/{propertyId}

### Description
Deletes a file property for a resource.

### Method
DELETE

### Endpoint
/api/resources/{resourceId}/file-properties/{propertyId}
```

```APIDOC
## GET /api/resources/{resourceId}/file-properties/{propertyId}

### Description
Retrieves a specific file property of a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/file-properties/{propertyId}
```

```APIDOC
## POST /api/resources/{resourceId}/file-properties

### Description
Sets a file property for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/file-properties
```

--------------------------------

### Tasks - Capacity - Available Capacity

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing available capacity.

```APIDOC
## GET /api/capacity/available

### Description
Retrieves the available capacity information.

### Method
GET

### Endpoint
/api/capacity/available
```

--------------------------------

### Metadata API - Routing Profiles

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

APIs for managing routing plans and profiles.

```APIDOC
## POST /api/metadata/routingprofiles/plans

### Description
Adds a routing plan.

### Method
POST

### Endpoint
/api/metadata/routingprofiles/plans

### Request Body
- **planDetails** (object) - Required - Details of the routing plan.

### Request Example
{
  "planDetails": {
    "name": "Daily Route Optimization"
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Routing plan added successfully."
}
```

```APIDOC
## POST /api/metadata/routingprofiles/plans/forceadd

### Description
Forces the addition of a routing plan.

### Method
POST

### Endpoint
/api/metadata/routingprofiles/plans/forceadd

### Request Body
- **planDetails** (object) - Required - Details of the routing plan.

### Request Example
{
  "planDetails": {
    "name": "Emergency Route"
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Routing plan forced successfully."
}
```

```APIDOC
## GET /api/metadata/routingprofiles/plans/{planId}

### Description
Retrieves a specific routing plan.

### Method
GET

### Endpoint
/api/metadata/routingprofiles/plans/{planId}

### Parameters
#### Path Parameters
- **planId** (string) - Required - The ID of the routing plan.

### Response
#### Success Response (200)
- **plan** (object) - The routing plan details.

#### Response Example
{
  "plan": {
    "id": "plan1",
    "name": "Daily Route Optimization"
  }
}
```

```APIDOC
## GET /api/metadata/routingprofiles/plans/labels

### Description
Retrieves labels for routing plans.

### Method
GET

### Endpoint
/api/metadata/routingprofiles/plans/labels

### Response
#### Success Response (200)
- **labels** (array) - A list of routing plan labels.

#### Response Example
{
  "labels": [
    "Daily Route Optimization",
    "Emergency Route"
  ]
}
```

```APIDOC
## GET /api/metadata/routingprofiles/labels

### Description
Retrieves labels for routing profiles.

### Method
GET

### Endpoint
/api/metadata/routingprofiles/labels

### Response
#### Success Response (200)
- **labels** (array) - A list of routing profile labels.

#### Response Example
{
  "labels": [
    "Profile A",
    "Profile B"
  ]
}
```

```APIDOC
## POST /api/metadata/routingprofiles/plans/start

### Description
Starts a routing plan.

### Method
POST

### Endpoint
/api/metadata/routingprofiles/plans/start

### Request Body
- **planId** (string) - Required - The ID of the routing plan to start.

### Request Example
{
  "planId": "plan1"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Routing plan started successfully."
}
```

--------------------------------

### Metadata API - Non-working Reasons

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

API for retrieving a list of non-working reasons.

```APIDOC
## GET /api/metadata/nonworkingreasons

### Description
Retrieves a list of non-working reasons.

### Method
GET

### Endpoint
/api/metadata/nonworkingreasons

### Response
#### Success Response (200)
- **reasons** (array) - A list of non-working reason objects.

#### Response Example
{
  "reasons": [
    {
      "id": "nwr1",
      "name": "Holiday"
    }
  ]
}
```

--------------------------------

### Tasks - Core - Events

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing event subscriptions and retrieval.

```APIDOC
## POST /api/events/subscriptions

### Description
Creates a new event subscription.

### Method
POST

### Endpoint
/api/events/subscriptions
```

```APIDOC
## DELETE /api/events/subscriptions/{subscriptionId}

### Description
Deletes an event subscription.

### Method
DELETE

### Endpoint
/api/events/subscriptions/{subscriptionId}
```

```APIDOC
## GET /api/events

### Description
Retrieves a list of events.

### Method
GET

### Endpoint
/api/events
```

```APIDOC
## GET /api/events/subscriptions/{subscriptionId}

### Description
Retrieves details of a specific event subscription.

### Method
GET

### Endpoint
/api/events/subscriptions/{subscriptionId}
```

```APIDOC
## GET /api/events/subscriptions

### Description
Retrieves a list of event subscriptions.

### Method
GET

### Endpoint
/api/events/subscriptions
```

--------------------------------

### Tasks - Core - Resources - Resource Locations

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resource locations.

```APIDOC
## POST /api/resources/{resourceId}/locations

### Description
Creates a new resource location.

### Method
POST

### Endpoint
/api/resources/{resourceId}/locations
```

```APIDOC
## DELETE /api/resources/{resourceId}/locations/assigned

### Description
Deletes assigned locations for a resource.

### Method
DELETE

### Endpoint
/api/resources/{resourceId}/locations/assigned
```

```APIDOC
## GET /api/resources/{resourceId}/locations/{locationId}

### Description
Retrieves a specific resource location.

### Method
GET

### Endpoint
/api/resources/{resourceId}/locations/{locationId}
```

```APIDOC
## GET /api/resources/{resourceId}/locations/assigned

### Description
Retrieves assigned locations for a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/locations/assigned
```

```APIDOC
## GET /api/resources/{resourceId}/locations

### Description
Retrieves a list of resource locations.

### Method
GET

### Endpoint
/api/resources/{resourceId}/locations
```

```APIDOC
## POST /api/resources/{resourceId}/locations/assigned/set

### Description
Sets assigned locations for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/locations/assigned/set
```

```APIDOC
## PUT /api/resources/{resourceId}/locations/{locationId}

### Description
Updates an existing resource location.

### Method
PUT

### Endpoint
/api/resources/{resourceId}/locations/{locationId}
```

```APIDOC
## PUT /api/resources/{resourceId}/locations/assigned/update

### Description
Updates assigned locations for a resource.

### Method
PUT

### Endpoint
/api/resources/{resourceId}/locations/assigned/update
```

--------------------------------

### Metadata API - Applications

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

APIs for managing applications within metadata.

```APIDOC
## POST /api/metadata/applications

### Description
Creates or updates an application.

### Method
POST

### Endpoint
/api/metadata/applications

### Request Body
- **id** (string) - Required - The ID of the application.
- **name** (string) - Required - The name of the application.

### Request Example
{
  "id": "app1",
  "name": "Mobile App"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Application created or updated successfully."
}
```

```APIDOC
## POST /api/metadata/applications/{appId}/clientsecret

### Description
Generates a client secret for an application.

### Method
POST

### Endpoint
/api/metadata/applications/{appId}/clientsecret

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **clientSecret** (string) - The generated client secret.

#### Response Example
{
  "clientSecret": "aBcDeFgHiJkLmNoPqRsT"
}
```

```APIDOC
## GET /api/metadata/applications/{appId}

### Description
Retrieves a specific application.

### Method
GET

### Endpoint
/api/metadata/applications/{appId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **id** (string) - The ID of the application.
- **name** (string) - The name of the application.

#### Response Example
{
  "id": "app1",
  "name": "Mobile App"
}
```

```APIDOC
## GET /api/metadata/applications/{appId}/apiaccess

### Description
Gets API access details for a specific application.

### Method
GET

### Endpoint
/api/metadata/applications/{appId}/apiaccess

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **accessDetails** (object) - API access details.

#### Response Example
{
  "accessDetails": {
    "scopes": ["read", "write"]
  }
}
```

```APIDOC
## GET /api/metadata/applications/{appId}/apiaccesses

### Description
Gets all API accesses for a specific application.

### Method
GET

### Endpoint
/api/metadata/applications/{appId}/apiaccesses

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **apiAccesses** (array) - A list of API access objects.

#### Response Example
{
  "apiAccesses": [
    {
      "scope": "read"
    },
    {
      "scope": "write"
    }
  ]
}
```

```APIDOC
## GET /api/metadata/applications

### Description
Retrieves a list of all applications.

### Method
GET

### Endpoint
/api/metadata/applications

### Response
#### Success Response (200)
- **applications** (array) - A list of application objects.

#### Response Example
{
  "applications": [
    {
      "id": "app1",
      "name": "Mobile App"
    }
  ]
}
```

```APIDOC
## PUT /api/metadata/applications/{appId}/apiaccess

### Description
Updates API access for an application.

### Method
PUT

### Endpoint
/api/metadata/applications/{appId}/apiaccess

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.

### Request Body
- **scopes** (array) - Required - A list of scopes to update.

### Request Example
{
  "scopes": ["read", "execute"]
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "API access updated successfully."
}
```

--------------------------------

### Tasks - Capacity - Booking

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing booking-related functionalities.

```APIDOC
## GET /api/booking/fields/dependencies

### Description
Retrieves booking fields dependencies.

### Method
GET

### Endpoint
/api/booking/fields/dependencies
```

```APIDOC
## GET /api/booking/options

### Description
Retrieves activity booking options.

### Method
GET

### Endpoint
/api/booking/options
```

```APIDOC
## GET /api/booking/grid

### Description
Shows the booking grid.

### Method
GET

### Endpoint
/api/booking/grid
```

--------------------------------

### Tasks - Core - Resources - Resource Work Schedules

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resource work schedules.

```APIDOC
## DELETE /api/resources/{resourceId}/work-schedules/{scheduleItemId}

### Description
Deletes a work schedule item for a resource.

### Method
DELETE

### Endpoint
/api/resources/{resourceId}/work-schedules/{scheduleItemId}
```

```APIDOC
## GET /api/resources/{resourceId}/calendars/{calendarId}

### Description
Retrieves a specific calendar for a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/calendars/{calendarId}
```

```APIDOC
## GET /api/resources/{resourceId}/calendars

### Description
Retrieves a list of calendars for a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/calendars
```

```APIDOC
## GET /api/resources/{resourceId}/work-schedules

### Description
Retrieves work schedules for a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/work-schedules
```

```APIDOC
## POST /api/resources/{resourceId}/work-schedules

### Description
Sets a work schedule item for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/work-schedules
```

--------------------------------

### Tasks - Core - Extracts - Daily Extracts

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for retrieving daily extract files and dates.

```APIDOC
## GET /api/extracts/daily/{date}/file

### Description
Retrieves a specific daily extract file for a given date.

### Method
GET

### Endpoint
/api/extracts/daily/{date}/file
```

```APIDOC
## GET /api/extracts/daily/{date}

### Description
Retrieves a list of daily extract files for a specific date.

### Method
GET

### Endpoint
/api/extracts/daily/{date}
```

```APIDOC
## GET /api/extracts/daily/dates

### Description
Retrieves a list of available daily extract dates.

### Method
GET

### Endpoint
/api/extracts/daily/dates
```

--------------------------------

### Tasks - Core - Resources

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resources and their associated data.

```APIDOC
## POST /api/resources/bulk-update/inventories

### Description
Performs a bulk update on resource inventories.

### Method
POST

### Endpoint
/api/resources/bulk-update/inventories
```

```APIDOC
## POST /api/resources/bulk-update/work-schedules

### Description
Performs a bulk update on resource work schedules.

### Method
POST

### Endpoint
/api/resources/bulk-update/work-schedules
```

```APIDOC
## POST /api/resources/bulk-update/work-skills

### Description
Performs a bulk update on resource work skills.

### Method
POST

### Endpoint
/api/resources/bulk-update/work-skills
```

```APIDOC
## POST /api/resources/bulk-update/work-zones

### Description
Performs a bulk update on resource work zones.

### Method
POST

### Endpoint
/api/resources/bulk-update/work-zones
```

```APIDOC
## POST /api/resources

### Description
Creates a new resource.

### Method
POST

### Endpoint
/api/resources
```

```APIDOC
## POST /api/resources/{resourceId}/inventories

### Description
Creates a new inventory for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/inventories
```

```APIDOC
## GET /api/resources/find/matching

### Description
Finds matching resources based on criteria.

### Method
GET

### Endpoint
/api/resources/find/matching
```

```APIDOC
## GET /api/resources/find/nearby-activities

### Description
Finds nearby activities for resources.

### Method
GET

### Endpoint
/api/resources/find/nearby-activities
```

```APIDOC
## GET /api/resources/find/urgent-assignment

### Description
Finds resources for urgent assignment.

### Method
GET

### Endpoint
/api/resources/find/urgent-assignment
```

```APIDOC
## GET /api/resources/assistants

### Description
Retrieves a list of assistant resources.

### Method
GET

### Endpoint
/api/resources/assistants
```

```APIDOC
## GET /api/resources/{resourceId}

### Description
Retrieves details of a specific resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}
```

```APIDOC
## GET /api/resources/{resourceId}/children

### Description
Retrieves child resources of a given resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/children
```

```APIDOC
## GET /api/resources/{resourceId}/descendants

### Description
Retrieves descendant resources of a given resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/descendants
```

```APIDOC
## GET /api/resources/{resourceId}/inventories

### Description
Retrieves inventories associated with a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/inventories
```

```APIDOC
## GET /api/resources

### Description
Retrieves a list of resources.

### Method
GET

### Endpoint
/api/resources
```

```APIDOC
## POST /api/resources/{resourceId}/inventories/install

### Description
Installs an inventory for a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/inventories/install
```

```APIDOC
## PUT /api/resources/{resourceId}

### Description
Updates an existing resource.

### Method
PUT

### Endpoint
/api/resources/{resourceId}
```

--------------------------------

### Tasks - Core - Resources - Resource Positions

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for retrieving resource positions.

```APIDOC
## GET /api/resources/positions/last-known

### Description
Retrieves the last known positions of resources.

### Method
GET

### Endpoint
/api/resources/positions/last-known
```

```APIDOC
## GET /api/resources/{resourceId}/positions/history

### Description
Retrieves the position history of a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/positions/history
```

```APIDOC
## GET /api/resources/positions/in-area

### Description
Retrieves resources located within a specified area.

### Method
GET

### Endpoint
/api/resources/positions/in-area
```

```APIDOC
## POST /api/resources/positions/set

### Description
Sets positions for resources.

### Method
POST

### Endpoint
/api/resources/positions/set
```

--------------------------------

### Tasks - Capacity - Quota

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing quota for v1 and v2.

```APIDOC
## POST /api/quota/v1

### Description
Creates or updates quota for v1.

### Method
POST

### Endpoint
/api/quota/v1
```

```APIDOC
## GET /api/quota/v1

### Description
Retrieves quota for v1.

### Method
GET

### Endpoint
/api/quota/v1
```

```APIDOC
## POST /api/quota/v2

### Description
Creates or updates quota for v2.

### Method
POST

### Endpoint
/api/quota/v2
```

```APIDOC
## GET /api/quota/v2

### Description
Retrieves quota for v2.

### Method
GET

### Endpoint
/api/quota/v2
```

--------------------------------

### Metadata API - Activity Types

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

APIs for managing activity types within metadata.

```APIDOC
## POST /api/metadata/activitytypes

### Description
Creates or updates an activity type.

### Method
POST

### Endpoint
/api/metadata/activitytypes

### Request Body
- **id** (string) - Required - The ID of the activity type.
- **name** (string) - Required - The name of the activity type.
- **groupId** (string) - Required - The ID of the associated activity type group.

### Request Example
{
  "id": "at1",
  "name": "Install",
  "groupId": "atg1"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Activity type created or updated successfully."
}
```

```APIDOC
## GET /api/metadata/activitytypes

### Description
Retrieves a list of activity types.

### Method
GET

### Endpoint
/api/metadata/activitytypes

### Response
#### Success Response (200)
- **activityTypes** (array) - A list of activity type objects.

#### Response Example
{
  "activityTypes": [
    {
      "id": "at1",
      "name": "Install",
      "groupId": "atg1"
    }
  ]
}
```

```APIDOC
## GET /api/metadata/activitytypes/{activityTypeId}

### Description
Retrieves a specific activity type.

### Method
GET

### Endpoint
/api/metadata/activitytypes/{activityTypeId}

### Parameters
#### Path Parameters
- **activityTypeId** (string) - Required - The ID of the activity type.

### Response
#### Success Response (200)
- **id** (string) - The ID of the activity type.
- **name** (string) - The name of the activity type.
- **groupId** (string) - The ID of the associated activity type group.

#### Response Example
{
  "id": "at1",
  "name": "Install",
  "groupId": "atg1"
}
```

--------------------------------

### Metadata API - Link Templates

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

APIs for managing link templates within metadata.

```APIDOC
## POST /api/metadata/linktemplates

### Description
Creates a link template.

### Method
POST

### Endpoint
/api/metadata/linktemplates

### Request Body
- **id** (string) - Required - The ID of the link template.
- **name** (string) - Required - The name of the link template.
- **url** (string) - Required - The URL for the link template.

### Request Example
{
  "id": "lt1",
  "name": "Customer Portal Link",
  "url": "https://example.com/portal"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Link template created successfully."
}
```

```APIDOC
## GET /api/metadata/linktemplates/{templateId}

### Description
Retrieves a specific link template.

### Method
GET

### Endpoint
/api/metadata/linktemplates/{templateId}

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The ID of the link template.

### Response
#### Success Response (200)
- **id** (string) - The ID of the link template.
- **name** (string) - The name of the link template.
- **url** (string) - The URL for the link template.

#### Response Example
{
  "id": "lt1",
  "name": "Customer Portal Link",
  "url": "https://example.com/portal"
}
```

```APIDOC
## GET /api/metadata/linktemplates

### Description
Retrieves a list of all link templates.

### Method
GET

### Endpoint
/api/metadata/linktemplates

### Response
#### Success Response (200)
- **linkTemplates** (array) - A list of link template objects.

#### Response Example
{
  "linkTemplates": [
    {
      "id": "lt1",
      "name": "Customer Portal Link",
      "url": "https://example.com/portal"
    }
  ]
}
```

```APIDOC
## PUT /api/metadata/linktemplates/{templateId}

### Description
Updates an existing link template.

### Method
PUT

### Endpoint
/api/metadata/linktemplates/{templateId}

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The ID of the link template to update.

### Request Body
- **name** (string) - Optional - The updated name of the link template.
- **url** (string) - Optional - The updated URL for the link template.

### Request Example
{
  "url": "https://example.com/newportal"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Link template updated successfully."
}
```

--------------------------------

### Metadata API - Work Zone Key

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

API for retrieving the work zone key.

```APIDOC
## GET /api/metadata/workzonekey

### Description
Retrieves the work zone key.

### Method
GET

### Endpoint
/api/metadata/workzonekey

### Response
#### Success Response (200)
- **key** (string) - The work zone key.

#### Response Example
{
  "key": "unique_work_zone_key"
}
```

--------------------------------

### Tasks - Core - Resources - Resource Work Skills

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing resource work skills.

```APIDOC
## DELETE /api/resources/{resourceId}/work-skills/{skillId}

### Description
Deletes a work skill for a resource.

### Method
DELETE

### Endpoint
/api/resources/{resourceId}/work-skills/{skillId}
```

--------------------------------

### Tasks - Core - Resources - Resource Assigned Users

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing users assigned to resources.

```APIDOC
## GET /api/resources/{resourceId}/users

### Description
Retrieves users assigned to a resource.

### Method
GET

### Endpoint
/api/resources/{resourceId}/users
```

```APIDOC
## POST /api/resources/{resourceId}/users/set

### Description
Assigns users to a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/users/set
```

```APIDOC
## POST /api/resources/{resourceId}/users/unset

### Description
Unassigns users from a resource.

### Method
POST

### Endpoint
/api/resources/{resourceId}/users/unset
```

--------------------------------

### Tasks - Capacity - Booking Closing Schedule

Source: https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/index.html

Endpoints for managing booking closing schedules and statuses.

```APIDOC
## POST /api/booking/closing-schedules

### Description
Creates or updates booking closing schedules.

### Method
POST

### Endpoint
/api/booking/closing-schedules
```

```APIDOC
## GET /api/booking/closing-schedules/{scheduleId}

### Description
Retrieves a specific booking closing schedule.

### Method
GET

### Endpoint
/api/booking/closing-schedules/{scheduleId}
```

```APIDOC
## GET /api/booking/statuses

### Description
Retrieves booking statuses.

### Method
GET

### Endpoint
/api/booking/statuses
```

```APIDOC
## PUT /api/booking/statuses/{statusId}

### Description
Updates booking statuses.

### Method
PUT

### Endpoint
/api/booking/statuses/{statusId}
```