Export (Knowledge Graph Service) | ArcGIS REST APIs

URL:: https://<knowledgegraphserver_datatransfer-url>/export
Methods:: POST
Version Introduced:: 12.0

Description

The Export operation exports the service definition for a knowledge graph service. The resulting service definition can then be published as a new knowledge graph service in an ArcGIS Enterprise organization. The owner of the knowledge graph service and administrators of the ArcGIS Enterprise organization can always export its service definition. By default, other users cannot export the knowledge graph service. You can enable the Extract capability, allowing other users to export the service definition by managing the knowledge graph settings.

The Export operation allows an organization to move their knowledge graph services from one system to another while conserving the service's references and configured parameters.

Request parameters

Parameter Details

Parameter	Details
`export service definition name` (Required)	The knowledge graph service's name.
`dataFormat` (Required)	The data storage format of knowledge graph service in the exported the service definition. The only supported format is `EXPORT_DATA_FORMAT_GEOPARQUET`.
`f`	The response format. The default format is `html`. Values: `pbf` \| `html`

export service definition name

(Required)

The knowledge graph service's name.

dataFormat

(Required)

The data storage format of knowledge graph service in the exported the service definition. The only supported format is EXPORT_DATA_FORMAT_GEOPARQUET.

f

The response format. The default format is html.

Values: pbf | html

Example workflow

Below is a sample workflow to export a knowledge graph service named SupplyChain using html responses:

Submit an export job using a request URL:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/Hosted/SupplyChain/KnowledgeGraphServer/dataTransfer/export?f=html

Access the job status URL:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/Hosted/SupplyChain/KnowledgeGraphServer/jobs/j8566a874-3854-43a9-96b7-b1cd7630d8c9/status?f=html

When the job is completed successfully, the resultsUrl can be used to access the job results.

Use dark colors for code blocksCopy
resultsUrl: https://organization.example.com/<context>/rest/services/Hosted/SupplyChain/KnowledgeGraphServer/jobs/j8566a874-3854-43a9-96b7-b1cd7630d8c9/results?f=html
asyncStatus: ASYNC_STATUS_COMPLETED
progressStatus:
  code: 114716
  message: DATA_TRANSFER_EXPORT_COMPLETED
lastUpdatedTime: 1758060659565
submissionTime: 1758060659350

Download the knowledge graph service's exported service definition by entering the serviceDefinitionDownloadUrl address into the browser window:

Use dark colors for code blocksCopy
completionTime: 1758058067803
exportServiceDefinitionResult:
  serviceDefinitionName: SupplyChain
  dataFormat: EXPORT_DATA_FORMAT_GEOPARQUET
  serviceDefinitionDownloadUrl: https://organization.example.com/<context>/rest/directories/arcgisoutput/Hosted/SupplyChain_KnowledgeGraphServer/_ags_kgs_j94bbe4c1-f76a-4d5c-8097-33ddfc51bc46/SupplyChain.sd
submissionTime: 1758058067565

Requests and responses

This operation can also be performed by sending a PBF-formatted request and receiving a PBF-formatted response. The status of the operation can be queried using a PBF-formatted response. Details of the request and response parameters are provided in the appropriate .proto files.

PBF Request

Create a PBF-formatted request to perform this operation based on the ExportRequest.proto file.

PBF Response

Create a PBF-formatted response to query the status of the operation based on the AsyncStatusResponse.proto file.

Once the operation is complete, download the service definition using the results_url in the PBF-formatted response based on the ExportResponse.proto file.