---
sourceDocument: Brazil API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/api-reference

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SAP SuccessFactors XCC

# SAP SuccessFactors XCC {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 10 minutes to read  
The SAP SuccessFactors XCC API.
Automates data uploads and crawl triggers for the SAP SuccessFactors external content connector.

Lets a caller programmatically attach the trainings, library-and-assignment-profile-mapping, and user data CSV (or zipped CSV) files that a SAP SuccessFactors Learning administrator exports. Starts the document and user mapping
crawls that index that data for AI Search, as an alternative to the connector's admin configuration UI.

This API works with CSV data files from the [Export SAP SuccessFactors Learning data for external content indexing](https://www.servicenow.com/docs/access?context=export-sap-successfactors-data-external-content-indexing&version=brazil&pubname=brazil-platform-administration&ft:locale=en-US) application.

Supports upload and crawl-start operations.

**Authentication** Supports both HTTP Basic authentication and OAuth 2.0; OAuth is recommended for production integrations.

OAuth 2.0 uses the Resource Owner Password Credentials grant. Register an OAuth client for external APIs in the instance's Application Registry, with a broadly scoped client scope restriction, then request a token:

    curl -X POST "https://<instance-url>/oauth_token.do" \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "grant_type=password&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password>"

Send the returned token on every request as `Authorization: Bearer <access_token>`.

* Mapping to ServiceNow Data Model
* Connector configuration: Uploaded file attachments map to the `sn_ext_conn_sap_sf_configuration` table.
* Crawl jobs: Crawl-start operations create records in the `sn_ext_conn_connector_job` table.

**Behavioral notes** Both crawl-start operations require the trainings, library-and-assignment-profile-mapping, and user data files to already be attached to the connector configuration. Requests are rejected for if a crawl of
the same type is already queued or in progress for that connector. Both return immediately after queuing the crawl job; the crawl itself, including indexing new content and permissions in AI Search, completes asynchronously. Uploads
reject files larger than the maximum size allowed by the `com.glide.attachment.max_size` system property (1 GB by default).

Requires:

* plugin: `com.sn_ext_conn_sap_sf` (External Content Connectors SAP SuccessFactors)
* depends on: `com.sn_ext_conn_admin` (External Content Connectors Admin)
* role: Not restricted to a specific role. Every operation requires authentication, and the platform's default Scripted REST access control denies requests from sessions holding the `snc_external` role.

Namespace information:

* Namespace: `sn_ext_conn_sap_sf`
* Base URI: `/api/sn_ext_conn_sap_sf/automate_successfactors_connector`

## SAP SuccessFactors XCC - PUT /users {#ariaid-title2}

Uploads the user-to-assignment-profile mapping data file that a SAP SuccessFactors Learning administrator exports, as an attachment on the connector configuration record identified by conn_sys_id.

### URL format

Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/u5yPzbegiHwmWzc30gVYJQ "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/lrq5et5qRFWUhx9Az0NIXg "The scripted REST API feature allows application developers to build custom web service APIs.").

Versioned URL: /api/sn_ext_conn_sap_sf/automate_successfactors_connector/users

### Supported request parameters

{#sap-successfactors-xcc-PUT-users__entry__2}{#sap-successfactors-xcc-PUT-users__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 1. Path parameters]

{#sap-successfactors-xcc-PUT-users__entry__7}

| Name | Description | Data type |
|-|-|-|
| None | This endpoint does not accept query parameters. |   |
[Table 2. Query parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#sap-successfactors-xcc-PUT-users__entry__12}{#sap-successfactors-xcc-PUT-users__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 3. Request headers]

{#sap-successfactors-xcc-PUT-users__entry__16}

| Header | Description |
|-|-|
| None | This endpoint returns no custom response headers. |
[Table 4. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#sap-successfactors-xcc-PUT-users__entry__20}{#sap-successfactors-xcc-PUT-users__entry-400-status-code}{#sap-successfactors-xcc-PUT-users__entry-401-status-code}{#sap-successfactors-xcc-PUT-users__entry-403-status-code}{#sap-successfactors-xcc-PUT-users__entry-404-status-code}{#sap-successfactors-xcc-PUT-users__entry-500-status-code}

| Status code | Description |
|-|-|
| 201 | Users file uploaded and attached to the connector configuration. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 403 | Forbidden. The user doesn't have access rights to the specified record. |
| 404 | Not found. The requested item wasn't found. |
| 415 |   |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 5. Status codes]

### Response body parameters (JSON or XML)

{#sap-successfactors-xcc-PUT-users__entry__37}

| Parameter | Description | Data type |
|-|-|-|
| result | Example: {"success": true, "message": "principal_full crawl started successfully", "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"}. | object |
[ ]

### cURL request

Example PUT request to /api/sn_ext_conn_sap_sf/automate_successfactors_connector/users.

    curl "https://instance.servicenow.com/api/sn_ext_conn_sap_sf/automate_successfactors_connector/users" \
    --request PUT \
    --header "Accept:application/json" \
    --user 'username':'password'

    {
      "result": {
        "result": {
          "success": true,
          "message": "File uploaded successfully",
          "attachment_sys_id": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
          "content_type": "text/csv",
          "size_bytes": 51340,
          "created_on": "2026-08-19 12:41:18"
        }
      }
    }

## SAP SuccessFactors XCC - PUT /training {#ariaid-title3}

Uploads the trainings data file that a SAP SuccessFactors Learning administrator exports, as an attachment on the connector configuration record identified by conn_sys_id.

### URL format

Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/u5yPzbegiHwmWzc30gVYJQ "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/lrq5et5qRFWUhx9Az0NIXg "The scripted REST API feature allows application developers to build custom web service APIs.").

Versioned URL: /api/sn_ext_conn_sap_sf/automate_successfactors_connector/training

### Supported request parameters

{#automate-successfactors-connector-PUT-training__entry__2}{#automate-successfactors-connector-PUT-training__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 6. Path parameters]

{#automate-successfactors-connector-PUT-training__entry__7}

| Name | Description | Data type |
|-|-|-|
| None | This endpoint does not accept query parameters. |   |
[Table 7. Query parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-PUT-training__entry__12}{#automate-successfactors-connector-PUT-training__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 8. Request headers]

{#automate-successfactors-connector-PUT-training__entry__16}

| Header | Description |
|-|-|
| None | This endpoint returns no custom response headers. |
[Table 9. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-PUT-training__entry__20}{#automate-successfactors-connector-PUT-training__entry-400-status-code}{#automate-successfactors-connector-PUT-training__entry-401-status-code}{#automate-successfactors-connector-PUT-training__entry-403-status-code}{#automate-successfactors-connector-PUT-training__entry-404-status-code}{#automate-successfactors-connector-PUT-training__entry-500-status-code}

| Status code | Description |
|-|-|
| 201 | Trainings file uploaded and attached to the connector configuration. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 403 | Forbidden. The user doesn't have access rights to the specified record. |
| 404 | Not found. The requested item wasn't found. |
| 415 |   |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 10. Status codes]

### Response body parameters (JSON or XML)

{#automate-successfactors-connector-PUT-training__entry__37}

| Parameter | Description | Data type |
|-|-|-|
| result | Example: {"success": true, "message": "principal_full crawl started successfully", "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"}. | object |
[ ]

### cURL request

Example PUT request to /api/sn_ext_conn_sap_sf/automate_successfactors_connector/training.

    curl "https://instance.servicenow.com/api/sn_ext_conn_sap_sf/automate_successfactors_connector/training" \
    --request PUT \
    --header "Accept:application/json" \
    --user 'username':'password'

    {
      "result": {
        "result": {
          "success": true,
          "message": "File uploaded successfully",
          "attachment_sys_id": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
          "content_type": "text/csv",
          "size_bytes": 51340,
          "created_on": "2026-08-19 12:41:18"
        }
      }
    }

## SAP SuccessFactors XCC - PUT /ap_lib_mapping {#ariaid-title4}

Uploads the library-and-assignment-profile-mapping data file that a SAP SuccessFactors Learning administrator exports, as an attachment on the connector configuration record identified by
`conn_sys_id`.

### URL format

Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/u5yPzbegiHwmWzc30gVYJQ "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/lrq5et5qRFWUhx9Az0NIXg "The scripted REST API feature allows application developers to build custom web service APIs.").

Versioned URL: /api/sn_ext_conn_sap_sf/automate_successfactors_connector/ap_lib_mapping

### Supported request parameters

{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__2}{#automate-successfactors-connector-PUT-ap-lib-mapping__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 11. Path parameters]

{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__7}

| Name | Description | Data type |
|-|-|-|
| None | This endpoint does not accept query parameters. |   |
[Table 12. Query parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__12}{#automate-successfactors-connector-PUT-ap-lib-mapping__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 13. Request headers]

{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__16}

| Header | Description |
|-|-|
| None | This endpoint returns no custom response headers. |
[Table 14. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__20}{#automate-successfactors-connector-PUT-ap-lib-mapping__entry-400-status-code}{#automate-successfactors-connector-PUT-ap-lib-mapping__entry-401-status-code}{#automate-successfactors-connector-PUT-ap-lib-mapping__entry-403-status-code}{#automate-successfactors-connector-PUT-ap-lib-mapping__entry-404-status-code}{#automate-successfactors-connector-PUT-ap-lib-mapping__entry-500-status-code}

| Status code | Description |
|-|-|
| 201 | Library-and-assignment-profile-mapping file uploaded and attached to the connector configuration. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 403 | Forbidden. The user doesn't have access rights to the specified record. |
| 404 | Not found. The requested item wasn't found. |
| 415 |   |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 15. Status codes]

### Response body parameters (JSON or XML)

{#automate-successfactors-connector-PUT-ap-lib-mapping__entry__37}

| Parameter | Description | Data type |
|-|-|-|
| result | Example: {"success": true, "message": "principal_full crawl started successfully", "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"}. | object |
[ ]

### cURL request

Example PUT request to /api/sn_ext_conn_sap_sf/automate_successfactors_connector/ap_lib_mapping.

    curl "https://instance.servicenow.com/api/sn_ext_conn_sap_sf/automate_successfactors_connector/ap_lib_mapping" \
    --request PUT \
    --header "Accept:application/json" \
    --user 'username':'password'

    {
      "result": {
        "result": {
          "success": true,
          "message": "File uploaded successfully",
          "attachment_sys_id": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
          "content_type": "text/csv",
          "size_bytes": 51340,
          "created_on": "2026-08-19 12:41:18"
        }
      }
    }

## SAP SuccessFactors XCC - POST /start_user_mapping_crawl {#ariaid-title5}

Queues a user mapping crawl job that reads the connector's most recently uploaded user and library-and-assignment-profile-mapping data files. Updates the access-control relationships AI Search uses to enforce each search
user's original document access restrictions.

### URL format

Versioned URL: /api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_user_mapping_crawl

### Supported request parameters

{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__2}{#automate-successfactors-connector-POST-start-user-mapping-crawl__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 16. Path parameters]

{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__7}

| Name | Description | Data type |
|-|-|-|
| None | This endpoint does not accept query parameters. |   |
[Table 17. Query parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__12}{#automate-successfactors-connector-POST-start-user-mapping-crawl__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 18. Request headers]

{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__16}

| Header | Description |
|-|-|
| None | This endpoint returns no custom response headers. |
[Table 19. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__20}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-200-status-code}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-400-status-code}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-401-status-code}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-403-status-code}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-404-status-code}{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 403 | Forbidden. The user doesn't have access rights to the specified record. |
| 404 | Not found. The requested item wasn't found. |
| 409 |   |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 20. Status codes]

### Response body parameters (JSON or XML)

{#automate-successfactors-connector-POST-start-user-mapping-crawl__entry__37}

| Parameter | Description | Data type |
|-|-|-|
| result | Example: {"success": true, "message": "principal_full crawl started successfully", "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"}. | object |
[ ]

### cURL request

Example POST request to /api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_user_mapping_crawl.

    curl "https://instance.servicenow.com/api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_user_mapping_crawl" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'

    {
      "result": {
        "result": {
          "success": true,
          "message": "principal_full crawl started successfully",
          "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"
        }
      }
    }

## SAP SuccessFactors XCC - POST /start_document_crawl {#ariaid-title6}

Queues a document crawl job that reads the connector's most recently uploaded trainings, library-and-assignment-profile-mapping, and user data files. Sends the discovered training content and metadata to AI Search for
indexing.

### URL format

Note:  
Available versions are specified in the [REST API Explorer](https://www.servicenow.com/docs/u5yPzbegiHwmWzc30gVYJQ "In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs."). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://www.servicenow.com/docs/lrq5et5qRFWUhx9Az0NIXg "The scripted REST API feature allows application developers to build custom web service APIs.").

Versioned URL: /api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_document_crawl

### Supported request parameters

{#automate-successfactors-connector-POST-start-document-crawl__entry__2}{#automate-successfactors-connector-POST-start-document-crawl__version-not_optional-RESTAPI}

| Name | Description |
|-|-|
| api_version | Optional. Version of the endpoint to access. For example, <kbd class="ph userinput">v1</kbd> or <kbd class="ph userinput">v2</kbd>. Only specify this value to use an endpoint version other than the latest. Data type: String |
[Table 21. Path parameters]

{#automate-successfactors-connector-POST-start-document-crawl__entry__7}

| Name | Description | Data type |
|-|-|-|
| None | This endpoint does not accept query parameters. |   |
[Table 22. Query parameters]

### Headers

The following request and response headers apply to this HTTP
action only, or apply to this action in a distinct way. For a list of general headers used
in the REST API, see [Supported REST API headers](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-POST-start-document-crawl__entry__12}{#automate-successfactors-connector-POST-start-document-crawl__accept-RESTAPI}

| Header | Description |
|-|-|
| Accept | Data format of the response body. Supported types: application/json or application/xml. Default: application/json |
[Table 23. Request headers]

{#automate-successfactors-connector-POST-start-document-crawl__entry__16}

| Header | Description |
|-|-|
| None | This endpoint returns no custom response headers. |
[Table 24. Response headers]

### Status codes

The following status codes apply to this HTTP action. For a
list of possible status codes used in the REST API, see [REST API HTTP response
codes](https://www.servicenow.com/docs/TSHwMH5MZNTdV2wXSUhSiw "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.").
{#automate-successfactors-connector-POST-start-document-crawl__entry__20}{#automate-successfactors-connector-POST-start-document-crawl__entry-200-status-code}{#automate-successfactors-connector-POST-start-document-crawl__entry-400-status-code}{#automate-successfactors-connector-POST-start-document-crawl__entry-401-status-code}{#automate-successfactors-connector-POST-start-document-crawl__entry-403-status-code}{#automate-successfactors-connector-POST-start-document-crawl__entry-404-status-code}{#automate-successfactors-connector-POST-start-document-crawl__entry-500-status-code}

| Status code | Description |
|-|-|
| 200 | Successful. The request was successfully processed. |
| 400 | Bad Request. A bad request type or malformed request was detected. |
| 401 | Unauthorized. The user credentials are incorrect or have not been passed. |
| 403 | Forbidden. The user doesn't have access rights to the specified record. |
| 404 | Not found. The requested item wasn't found. |
| 409 |   |
| 500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
[Table 25. Status codes]

### Response body parameters (JSON or XML)

{#automate-successfactors-connector-POST-start-document-crawl__entry__37}

| Parameter | Description | Data type |
|-|-|-|
| result | Example: {"success": true, "message": "principal_full crawl started successfully", "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"}. | object |
[ ]

### cURL request

Example POST request to /api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_document_crawl.

    curl "https://instance.servicenow.com/api/sn_ext_conn_sap_sf/automate_successfactors_connector/start_document_crawl" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'

    {
      "result": {
        "result": {
          "success": true,
          "message": "principal_full crawl started successfully",
          "crawl_job_id": "5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d"
        }
      }
    }