Plan JSON import.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/entity/example/data-transfer/import/json/plan"), Content = new MultipartFormDataContent { new StringContent("example") { Headers = { ContentType = new MediaTypeHeaderValue("text/plain"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "ProfileId", } } }, new StringContent("") { Headers = { ContentType = new MediaTypeHeaderValue("application/octet-stream"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "File", FileName = "file", } } }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/entity/example/data-transfer/import/json/plan';const form = new FormData();form.append('ProfileId', 'example');form.append('File', 'file');
const options = {method: 'POST'};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/entity/example/data-transfer/import/json/plan \ --header 'Content-Type: multipart/form-data' \ --form ProfileId=example \ --form File=@fileGenerates a non-destructive import plan for an uploaded JSON entity export package.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity definition identifier or normalized entity key.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”object
Data transfer profile identifier.
Uploaded JSON export package.
Responses
Section titled “Responses”OK
object
Non-destructive JSON import plan for entity instances.
object
JSON data transfer format version.
UTC timestamp when the plan was generated.
Entity definition metadata included in a JSON export document.
object
Entity definition identifier.
Internal entity key.
User-facing singular display name.
User-facing plural display name.
Import profile metadata used to generate a JSON import plan.
object
Profile identifier.
Stable profile key.
User-facing profile name.
Aggregate counts for a JSON import plan.
object
Total uploaded record count.
Rows that can move forward to apply in a later sprint.
Rows with blocking errors.
Rows with non-blocking warnings.
Rows classified as creates.
Rows classified as updates.
Rows classified as skipped.
Warning and error counts grouped into stable workflow categories.
Aggregate import issue count grouped by stable UI category and severity.
object
Number of row issues in this category and severity.
Per-record plan rows.
One planned JSON import row.
object
One-based row index in the uploaded JSON records array.
Resolved identity value used for matching.
Matched runtime entity instance id when the row updates an existing record.
Blocking row or field errors.
object
object
Non-blocking row or field warnings.
object
object
object
object
object
object
Example
{ "Data": { "Profile": { "ImportMode": 0, "IdentityMode": 0 }, "IssueCategories": [ { "Category": 0, "Severity": 0 } ], "Rows": [ { "Action": 0, "Status": 0, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Non-destructive JSON import plan for entity instances.
object
JSON data transfer format version.
UTC timestamp when the plan was generated.
Entity definition metadata included in a JSON export document.
object
Entity definition identifier.
Internal entity key.
User-facing singular display name.
User-facing plural display name.
Import profile metadata used to generate a JSON import plan.
object
Profile identifier.
Stable profile key.
User-facing profile name.
Aggregate counts for a JSON import plan.
object
Total uploaded record count.
Rows that can move forward to apply in a later sprint.
Rows with blocking errors.
Rows with non-blocking warnings.
Rows classified as creates.
Rows classified as updates.
Rows classified as skipped.
Warning and error counts grouped into stable workflow categories.
Aggregate import issue count grouped by stable UI category and severity.
object
Number of row issues in this category and severity.
Per-record plan rows.
One planned JSON import row.
object
One-based row index in the uploaded JSON records array.
Resolved identity value used for matching.
Matched runtime entity instance id when the row updates an existing record.
Blocking row or field errors.
object
object
Non-blocking row or field warnings.
object
object
object
object
object
object
Example
{ "Data": { "Profile": { "ImportMode": 0, "IdentityMode": 0 }, "IssueCategories": [ { "Category": 0, "Severity": 0 } ], "Rows": [ { "Action": 0, "Status": 0, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Non-destructive JSON import plan for entity instances.
object
JSON data transfer format version.
UTC timestamp when the plan was generated.
Entity definition metadata included in a JSON export document.
object
Entity definition identifier.
Internal entity key.
User-facing singular display name.
User-facing plural display name.
Import profile metadata used to generate a JSON import plan.
object
Profile identifier.
Stable profile key.
User-facing profile name.
Aggregate counts for a JSON import plan.
object
Total uploaded record count.
Rows that can move forward to apply in a later sprint.
Rows with blocking errors.
Rows with non-blocking warnings.
Rows classified as creates.
Rows classified as updates.
Rows classified as skipped.
Warning and error counts grouped into stable workflow categories.
Aggregate import issue count grouped by stable UI category and severity.
object
Number of row issues in this category and severity.
Per-record plan rows.
One planned JSON import row.
object
One-based row index in the uploaded JSON records array.
Resolved identity value used for matching.
Matched runtime entity instance id when the row updates an existing record.
Blocking row or field errors.
object
object
Non-blocking row or field warnings.
object
object
object
object
object
object
Example
{ "Data": { "Profile": { "ImportMode": 0, "IdentityMode": 0 }, "IssueCategories": [ { "Category": 0, "Severity": 0 } ], "Rows": [ { "Action": 0, "Status": 0, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Non-destructive JSON import plan for entity instances.
object
JSON data transfer format version.
UTC timestamp when the plan was generated.
Entity definition metadata included in a JSON export document.
object
Entity definition identifier.
Internal entity key.
User-facing singular display name.
User-facing plural display name.
Import profile metadata used to generate a JSON import plan.
object
Profile identifier.
Stable profile key.
User-facing profile name.
Aggregate counts for a JSON import plan.
object
Total uploaded record count.
Rows that can move forward to apply in a later sprint.
Rows with blocking errors.
Rows with non-blocking warnings.
Rows classified as creates.
Rows classified as updates.
Rows classified as skipped.
Warning and error counts grouped into stable workflow categories.
Aggregate import issue count grouped by stable UI category and severity.
object
Number of row issues in this category and severity.
Per-record plan rows.
One planned JSON import row.
object
One-based row index in the uploaded JSON records array.
Resolved identity value used for matching.
Matched runtime entity instance id when the row updates an existing record.
Blocking row or field errors.
object
object
Non-blocking row or field warnings.
object
object
object
object
object
object
Example
{ "Data": { "Profile": { "ImportMode": 0, "IdentityMode": 0 }, "IssueCategories": [ { "Category": 0, "Severity": 0 } ], "Rows": [ { "Action": 0, "Status": 0, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}