GET /structured-content/content-types/{content_type_id}/managed-migrations

1 min

GET

https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations

Experimental Retrieves a list of managed migration jobs for a specific content type.

Path Parameters

content_type_idstringrequired
Example
645cb61c966d0c591320f636
Description
Unique identifier of the content type.

Query Parameters

content_migration_summaryboolean
Example
true
Description
Whether include a summary of content migration status (total, not started, succeeded, errored).
Default
false
offsetinteger
Example
10
Description
Pagination offset (number of jobs to skip).
Default
0
Minimum
0
limitinteger
Example
25
Description
Pagination limit (number of jobs to return).
Default
100
Minimum
1

Responses

200List of managed migration jobs for the content type.

SCContentTypeManagedMigrationResponse[]
- idstring
  Description
  The ID of the managed migration job.
- instance_idstring
  Description
  The ID of the instance.
- content_type_idstring
  Description
  The ID of the content type.
- source_content_type_version_idstring
  Description
  The ID of the source content type version.
- target_content_type_version_idstring
  Description
  The ID of the target content type version.
- default_valuesobject
  Description
  The default values for the content type.
- statusstring<not_started | in_progress | success | error>
  Description
  The status of the managed migration job.
  Allowed
  not_startedin_progresssuccesserror
- created_atstring<date-time>
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the managed migration job was created, in ISO 8601 UTC format (2020-02-10T10:40
  ).
  Format
  date-time
- updated_atstring
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the managed migration job was last updated, in ISO 8601 UTC format (2020-02-10T10:40
  ).
- content_migration_summaryContentMigrationSummary
  - totalinteger
    Description
    The total number of content items.
  - not_startedinteger
    Description
    The number of content items that haven't started migrating.
  - succeededinteger
    Description
    The number of content items that migrated successfully.
  - erroredinteger
    Description
    The number of content items that failed to migrate.
  - skippedinteger
    Description
    The number of content items that are skipped due to content type version ID mismatch.

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations?content_migration_summary=true&offset=10&limit=100' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations?content_migration_summary=true&offset=10&limit=100", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations?content_migration_summary=true&offset=10&limit=100")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations?content_migration_summary=true&offset=10&limit=100"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of managed migration jobs for the content type.
[
  {
    "id": "",
    "instance_id": "",
    "content_type_id": "",
    "source_content_type_version_id": "",
    "target_content_type_version_id": "",
    "default_values": {},
    "status": "",
    "created_at": "2019-10-06T13:15:30Z",
    "updated_at": "2019-10-06T13:15:30Z",
    "content_migration_summary": {
      "total": 0,
      "not_started": 0,
      "succeeded": 0,
      "errored": 0,
      "skipped": 0
    }
  }
]