Update base metadata for one data transfer profile.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-data-transfer-profiles/example/base"), Content = new StringContent("{ \"Name\": \"example\", \"Key\": \"example\", \"Direction\": 0, \"Format\": 0, \"IdentityMode\": 0, \"IdentityFieldId\": \"example\", \"ImportMode\": 0, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Description\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};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/admin/entity-data-transfer-profiles/example/base';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"Name":"example","Key":"example","Direction":0,"Format":0,"IdentityMode":0,"IdentityFieldId":"example","ImportMode":0,"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Description":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/workspace/admin/entity-data-transfer-profiles/example/base \ --header 'Content-Type: application/json' \ --data '{ "Name": "example", "Key": "example", "Direction": 0, "Format": 0, "IdentityMode": 0, "IdentityFieldId": "example", "ImportMode": 0, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Description": "example" }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”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”Request payload to update the base metadata of an entity data transfer profile.
object
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Expected profile row version.
Optional user-facing workflow description.
Request payload to update the base metadata of an entity data transfer profile.
object
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Expected profile row version.
Optional user-facing workflow description.
Request payload to update the base metadata of an entity data transfer profile.
object
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Expected profile row version.
Optional user-facing workflow description.
Responses
Section titled “Responses”OK
object
Detailed metadata for one entity data transfer profile.
object
Profile identifier.
Owning entity definition identifier.
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Configured profile fields.
One configured entity data transfer profile field.
object
Profile field identifier.
Owning profile identifier.
Referenced entity field definition identifier.
Owning entity definition table identifier.
Referenced field key.
Referenced field display name.
Whether the field participates in export.
Whether the field participates in import.
Sort order inside the profile field list.
Concurrency token.
Configured reference resolvers.
One configured reference resolver for a profile field.
object
Resolver identifier.
Owning profile field identifier.
Optional target field identifier.
Optional target field key.
Optional target field display name.
Sort order inside the profile field resolver list.
Concurrency token.
Concurrency token.
Optional user-facing workflow description.
object
object
object
object
Example
{ "Data": { "Direction": 0, "Format": 0, "IdentityMode": 0, "ImportMode": 0, "Fields": [ { "FieldType": 0, "TableHandlingMode": 0 } ], "ReferenceResolvers": [ { "ResolverMode": 0, "TargetDecision": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Detailed metadata for one entity data transfer profile.
object
Profile identifier.
Owning entity definition identifier.
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Configured profile fields.
One configured entity data transfer profile field.
object
Profile field identifier.
Owning profile identifier.
Referenced entity field definition identifier.
Owning entity definition table identifier.
Referenced field key.
Referenced field display name.
Whether the field participates in export.
Whether the field participates in import.
Sort order inside the profile field list.
Concurrency token.
Configured reference resolvers.
One configured reference resolver for a profile field.
object
Resolver identifier.
Owning profile field identifier.
Optional target field identifier.
Optional target field key.
Optional target field display name.
Sort order inside the profile field resolver list.
Concurrency token.
Concurrency token.
Optional user-facing workflow description.
object
object
object
object
Example
{ "Data": { "Direction": 0, "Format": 0, "IdentityMode": 0, "ImportMode": 0, "Fields": [ { "FieldType": 0, "TableHandlingMode": 0 } ], "ReferenceResolvers": [ { "ResolverMode": 0, "TargetDecision": 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
Detailed metadata for one entity data transfer profile.
object
Profile identifier.
Owning entity definition identifier.
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Configured profile fields.
One configured entity data transfer profile field.
object
Profile field identifier.
Owning profile identifier.
Referenced entity field definition identifier.
Owning entity definition table identifier.
Referenced field key.
Referenced field display name.
Whether the field participates in export.
Whether the field participates in import.
Sort order inside the profile field list.
Concurrency token.
Configured reference resolvers.
One configured reference resolver for a profile field.
object
Resolver identifier.
Owning profile field identifier.
Optional target field identifier.
Optional target field key.
Optional target field display name.
Sort order inside the profile field resolver list.
Concurrency token.
Concurrency token.
Optional user-facing workflow description.
object
object
object
object
Example
{ "Data": { "Direction": 0, "Format": 0, "IdentityMode": 0, "ImportMode": 0, "Fields": [ { "FieldType": 0, "TableHandlingMode": 0 } ], "ReferenceResolvers": [ { "ResolverMode": 0, "TargetDecision": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Detailed metadata for one entity data transfer profile.
object
Profile identifier.
Owning entity definition identifier.
User-facing profile name.
Stable technical profile key.
Optional identity field identifier.
Configured profile fields.
One configured entity data transfer profile field.
object
Profile field identifier.
Owning profile identifier.
Referenced entity field definition identifier.
Owning entity definition table identifier.
Referenced field key.
Referenced field display name.
Whether the field participates in export.
Whether the field participates in import.
Sort order inside the profile field list.
Concurrency token.
Configured reference resolvers.
One configured reference resolver for a profile field.
object
Resolver identifier.
Owning profile field identifier.
Optional target field identifier.
Optional target field key.
Optional target field display name.
Sort order inside the profile field resolver list.
Concurrency token.
Concurrency token.
Optional user-facing workflow description.
object
object
object
object
Example
{ "Data": { "Direction": 0, "Format": 0, "IdentityMode": 0, "ImportMode": 0, "Fields": [ { "FieldType": 0, "TableHandlingMode": 0 } ], "ReferenceResolvers": [ { "ResolverMode": 0, "TargetDecision": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}