PATCH /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}

1 min

PATCH

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

Experimental Update a managed migration job.

Path Parameters

content_type_idstringrequired
Example
645cb61c966d0c591320f636
Description
Unique identifier of the content type.
job_idstringrequired
Description
Unique identifier of the managed migration job.

Body Parameters

bodyobjectrequired
Description
Payload for default field values.
- default_valuesLocalizedFieldValuesrequired
  - localestringrequired
  - field_valuesLocationFieldValueModel[]required
    - longitudenumberrequired
      Description
      Longitude of the field value
    - latitudenumberrequired
      Description
      Longitude of the field value
    - order_indexinteger
      Description
      Order index of the field value

Responses

200Successful response

object
- updatedboolean
  Description
  True if the managed migration job is updated.

422Validation error

HTTPValidationError
- detailValidationError[]
  Description
  Details of the error
  - locstring[]required
    Description
    Locations where the error occurred
  - msgstringrequired
    Description
    Message describing the error
  - typestringrequired
    Description
    Type of the error

curl

curl --request PATCH \
     --url https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations/{job_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "default_values": {
     "locale": "",
     "field_values": [
     {
     "longitude": "",
     "latitude": ""
     }
     ]
     }
     }'

javascript

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

var raw = JSON.stringify({
   "default_values": {
      "locale": "",
      "field_values": [
         {
            "longitude": "",
            "latitude": ""
         }
      ]
   }
});

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}/managed-migrations/{job_id}", 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/{job_id}")

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

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "default_values": {
      "locale": "",
      "field_values": [
         {
            "longitude": "",
            "latitude": ""
         }
      ]
   }
})

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/{job_id}"

payload = json.dumps({
   "default_values": {
      "locale": "",
      "field_values": [
         {
            "longitude": "",
            "latitude": ""
         }
      ]
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful response
{
  "updated": false
}

422

// Validation error
{
  "detail": [
    {
      "loc": [
        ""
      ],
      "msg": "",
      "type": ""
    }
  ]
}