Skip to content
Arc XP

Using Migration Center to circulate documents during a migration

Migration Center API allows you to pass circulations along with the ANS of the document you want to migrate. You can leverage this feature to circulate your documents to one or many websites using a single API request to the POST /ans Migration Center API endpoint.

Request Syntax

The supported syntax to pass the website URL for each circulation of the migrating document is shown here:

{
    "circulations": [
        {
            "website_url": "/foo",
            "website_id": "website_1",
            "website_primary_section": {},
            "website_sections": []
        }
    ],
    "ANS": {
        "type": "story"
    }
}

Key Points

  • The request syntax instructs the Arc XP Publishing Platform to use the website URL provided under the Circulation and turn off automatic URL generation.

  • The website_url should be set for each circulation as shown here:

{
    "circulations": [
        {
            "website_url": "/foo",
            "website_id": "website_1",
            "website_primary_section": {},
            "website_sections": []
        },
        {
            "website_url": "/bar",
            "website_id": "website_2",
            "website_primary_section": {},
            "website_sections": []
        },
    ],
    "ANS": {
        "type": "story"
    }
}
  • The Arc XP Publishing Platform ignores the website_url property inside the ANS body, triggering an automatic URL generation for each website where the document is circulated.