POST /objects/migrations

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

API version that determines the response schema. The default version is used if this parameter is not included. Specify Zuora-Version in the request header if you expect a specific response schema.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

The actions of updating custom object definitions, to be performed as parts of the migration. Currently only one action per migration is supported.

A reference to a field.

Indicates whether to specify a unique constraint to the field. You can remove the unique constraint on the field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints.

The custom field definition in the custom object

The data format of the custom field

Applicable if the type of the action is updateField

Applicable if the type of the action is updateField

The UI label of the custom field

Indicates whether to use this field as the display name of the custom object when being linked to another custom object.

This field applies only to the Text custom field type:

• The type field is string.
• The enum field is not specified.

The data type of the custom field

Specifies that this is a custom field

Possible values:

• "custom"

The maximum length of string that can be stored in the custom field.

This field applies only to the following custom field types:

• Text:
  • The type field is string.
  • The format field is not specified or is url.
  • The enum field is not specified.
• Picklist:
  • The type field is string.
  • The enum field is specified.
  • The multiselect field is not specified or is false.
• Multiselect:
  • The type field is string.
  • The enum field is specified.
  • The multiselect field is true.

If the custom field is filterable, the value of maxLength must be 512 or less.

Indicates whether this is a multiselect custom field.

This field applies only to the creation of Picklist or Multiselect custom fields:

• The action type field is addField.
• The definition type field is string.
• The maxLength field is specified.
• The enum field is specified.

The name of the custom field to be updated

Indicates whether the field is filterable or not. Applicable to addField and updateField actions.

You can change a filterable field to non-filterable and vice versa. You can also add a filterable field. One custom object can have a maximum of 10 filterable fields.

Note that changing filterable fields triggers reindexing. It will take 12-24 hours before all your data are reindexed and available to query.

Indicates whether the field is required or optional.

You can update a required field to optional. On the other hand, you can only update an optional field to required on the custom object with no records.

You can only add a required field to the custom object with no records.

Indicates whether Audit Trail will record changes of this custom field. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields.

Required if the type of the action is renameField

The namespace of the custom object definition to be updated

Optional property for updateObject action

The API name of the custom object definition to be updated

Optional property for updateObject action

Specifies contraints to apply to custom object records.

Specifies whether Zuora validates the values of mapped fields in custom object records.

By default, Zuora validates the values of mapped fields in custom object records. For example, if the custom object definition has a field called AccountId__c that is mapped to the Id field of the account object, Zuora verifies that the value of AccountId__c is a valid account ID when a custom object record is created. If the value of AccountId__c is not a valid account ID, the operation fails.

Default value: true

The cardinality of the relationship from this object to another object.

Only the manyToOne cardinality can be used when creating relationships. A relationship with oneToMany cardinality is created implicitly when a manyToOne relationship is created.

A custom object definition can have a maximum of 2 manyToOne relationships.

Possible values:

• "manyToOne"

The namespace where the related object is located

The API name of the related object

Field mappings in the form of <this-object-field-name>: <other-object-field-name>.

The type of the updating action on a custom object definition

Possible values:

• "renameField"
• "updateObject"
• "addField"
• "deleteRelationship"
• "deleteField"
• "addRelationship"
• "updateField"

Optional property for updateObject action.

Indicates whether to audit the creation of custom object records of this custom object definition.

Note that you must enable the Custom Object Definition audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see Manage audit trail settings.

Optional property for updateObject action.

Indicates whether to audit the deletion of custom object records of this custom object definition.

Note that you must enable the Custom Object Definition audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see Manage audit trail settings.