Ctrl+K

Export a chain

Export a chain#

Description#

Returns an encoded string to be stored in a file with a .chain extension. The .chain file can then be used later during an import chain call.

Note: The exported chain will automatically expire and become unusable after 14 days. This has no bearing on the original chain or any imported copies.

POST /v1/chains/{chain_id}/export

Parameters#

Parameter

In

Type

Required

Description

chain_id

path

string

true

The ID of the Chain.

wk-target-workspace

header

string

false

The wk-target-workspace header is only required for requests made by a service provider application. This does not apply to the majority of Workiva Chains API users. This header specifies the ID of the target workspace on which the service provider application wishes to take action. This workspace must be managed by the service provider.

Detailed descriptions#

wk-target-workspace: The wk-target-workspace header is only required for requests made by a service provider application. This does not apply to the majority of Workiva Chains API users. This header specifies the ID of the target workspace on which the service provider application wishes to take action. This workspace must be managed by the service provider.

Code Samples#

curl -X POST https://h.app.wdesk.com/s/wdata/oc/api/v1/chains/{chain_id}/export \
    -H 'Accept: application/octet-stream' \
    -H 'wk-target-workspace: string' \
    -H 'Authorization: Bearer {access-token}'

http POST https://h.app.wdesk.com/s/wdata/oc/api/v1/chains/{chain_id}/export \
    Accept:application/octet-stream \
    wk-target-workspace:string \
    Authorization:"Bearer {access-token}"

wget --method=POST "https://h.app.wdesk.com/s/wdata/oc/api/v1/chains/{chain_id}/export" \
    --output-document -  \ 
    --header 'Accept: application/octet-stream' \ 
    --header 'wk-target-workspace: string' \ 
    --header 'Authorization: Bearer {access-token}'

import requests

headers = {
  'Accept': 'application/octet-stream',
  'wk-target-workspace': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://h.app.wdesk.com/s/wdata/oc/api/v1/chains/{chain_id}/export', headers = headers)

print(r.json())

Returns#

200 - OK#

Returns an encoded string to be stored in a .chain file for future importing.

Example Responses#

No example available