Copy global documents to another locale

POST

@apostrophecms

global

localize

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/global/localize \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_ids": [
    "<string>"
  ],
  "toLocales": [
    "<string>"
  ]
}
'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const job = await site.globalContent().localizeGlobals({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en'] });

{
  "jobId": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

global:write

Body

application/json

Documents to copy into other locales, by _id.

_ids

string[]

required

The documents’ _ids: a full id names its own locale and mode (a draft’s …:en:draft, a published …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

toLocales

string[]

required

The locales to copy them into (unknown locale names are skipped).

update

boolean

Overwrite a copy that already exists in a target locale (default false: an existing copy is left as it is).

Related document types to copy along (default none).

Copy only the related documents, not the listed ones (default false).

messages

object

The notification texts the CMS shows signed-in users while the job runs ({{ type }} and {{ count }} are filled in). Optional.

Show child attributes

Response

The job started.

A background job started: the work runs after this answer, so it says the job began, not that it finished. Each document is checked against the caller’s permissions as the job reaches it; one it may not touch is skipped, not an error. The management API follows a job (GET /@apostrophecms/job/{jobId}: its progress, what failed, when it ended); an API key can’t yet, so read the documents themselves to see the result.

jobId

string

required

The job’s id, for the management API’s job routes (read it, cancel it).

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/global/localize \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_ids": [
    "<string>"
  ],
  "toLocales": [
    "<string>"
  ]
}
'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const job = await site.globalContent().localizeGlobals({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en'] });

{
  "jobId": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Copy global documents to another locale

Authorizations

Scopes

Body

Response