PUT api/DataEntities/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

DataEntity

Name	Type	Additional information
Id	integer	None.
OrganisationId	integer	None.
ClientId	integer	None.
ParentRepoId	integer	None.
DemEntityId	integer	None.
DemUniqueId	globally unique identifier	None.
EntityName	string	None.
DataEntityTypeId	integer	None.
IsActive	boolean	None.
InFormId	integer	None.
IsDeleted	boolean	None.
IsPrivate	boolean	None.
HasSecondaryRepositories	boolean	None.
DataEntityType	DataEntityType	None.
DataEntityEndpoints	Collection of DataEntityEndpoint	None.
DataEntityLookups	Collection of DataEntityLookup	None.
DataEntityMatchings	Collection of DataEntityMatching	None.
DataEntityUsers	Collection of DataEntityUser	None.
DataEntityProcesses	Collection of DataEntityProcess	None.
DataEntityForms	Collection of DataEntityForm	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "OrganisationId": 1,
  "ClientId": 1,
  "ParentRepoId": 1,
  "DemEntityId": 1,
  "DemUniqueId": "91f4ff54-ef8e-491f-8cb5-58b624c96995",
  "EntityName": "sample string 2",
  "DataEntityTypeId": 1,
  "IsActive": true,
  "InFormId": 1,
  "IsDeleted": true,
  "IsPrivate": true,
  "HasSecondaryRepositories": true,
  "DataEntityType": {
    "Id": 1,
    "Type": "sample string 2"
  },
  "DataEntityEndpoints": [
    {
      "Id": 1,
      "Guid": "079c9ed9-cf64-43c3-bf40-ee9b6a5f53f3",
      "DataEntityId": 1,
      "Name": "sample string 2",
      "IsDeleted": true,
      "PerspectiveTableId": 4,
      "DataEntityEndpointColumns": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Alias": "sample string 6",
          "Ordinal": 1
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Alias": "sample string 6",
          "Ordinal": 1
        }
      ],
      "DataEntityRelationships": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "SourceTableId": 4,
          "SourceKeyFieldId": 5,
          "TargetTableId": 6,
          "TargetKeyFieldId": 7
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "SourceTableId": 4,
          "SourceKeyFieldId": 5,
          "TargetTableId": 6,
          "TargetKeyFieldId": 7
        }
      ],
      "DataEntityEndpointFilters": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Operator": "sample string 6",
          "Clause": "sample string 7",
          "Settable": true
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Operator": "sample string 6",
          "Clause": "sample string 7",
          "Settable": true
        }
      ]
    },
    {
      "Id": 1,
      "Guid": "079c9ed9-cf64-43c3-bf40-ee9b6a5f53f3",
      "DataEntityId": 1,
      "Name": "sample string 2",
      "IsDeleted": true,
      "PerspectiveTableId": 4,
      "DataEntityEndpointColumns": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Alias": "sample string 6",
          "Ordinal": 1
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Alias": "sample string 6",
          "Ordinal": 1
        }
      ],
      "DataEntityRelationships": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "SourceTableId": 4,
          "SourceKeyFieldId": 5,
          "TargetTableId": 6,
          "TargetKeyFieldId": 7
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "SourceTableId": 4,
          "SourceKeyFieldId": 5,
          "TargetTableId": 6,
          "TargetKeyFieldId": 7
        }
      ],
      "DataEntityEndpointFilters": [
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Operator": "sample string 6",
          "Clause": "sample string 7",
          "Settable": true
        },
        {
          "Id": 1,
          "DataEntityId": 2,
          "DataEntityEndpointId": 3,
          "DataEntityStructureId": 4,
          "DataEntityStructureFieldId": 5,
          "Operator": "sample string 6",
          "Clause": "sample string 7",
          "Settable": true
        }
      ]
    }
  ],
  "DataEntityLookups": [
    {
      "Id": 1,
      "DataEntityId": 1,
      "TableName": "sample string 2",
      "InFormId": 1,
      "DemUniqueId": "e0ceb99b-8fd8-430c-9e12-afaa40575f94",
      "IsDeleted": true,
      "DataEntityLookupForms": [
        {
          "Id": 1,
          "DataEntityLookupId": 2,
          "FormId": 3,
          "IsDeleted": true
        },
        {
          "Id": 1,
          "DataEntityLookupId": 2,
          "FormId": 3,
          "IsDeleted": true
        }
      ]
    },
    {
      "Id": 1,
      "DataEntityId": 1,
      "TableName": "sample string 2",
      "InFormId": 1,
      "DemUniqueId": "e0ceb99b-8fd8-430c-9e12-afaa40575f94",
      "IsDeleted": true,
      "DataEntityLookupForms": [
        {
          "Id": 1,
          "DataEntityLookupId": 2,
          "FormId": 3,
          "IsDeleted": true
        },
        {
          "Id": 1,
          "DataEntityLookupId": 2,
          "FormId": 3,
          "IsDeleted": true
        }
      ]
    }
  ],
  "DataEntityMatchings": [
    {
      "Id": 1,
      "DataEntityId": 1,
      "Name": "sample string 2",
      "MatchingId": 1,
      "IsDeleted": true,
      "LastRun": "2026-01-13T01:27:40.4964605+00:00"
    },
    {
      "Id": 1,
      "DataEntityId": 1,
      "Name": "sample string 2",
      "MatchingId": 1,
      "IsDeleted": true,
      "LastRun": "2026-01-13T01:27:40.4964605+00:00"
    }
  ],
  "DataEntityUsers": [
    {
      "Id": 1,
      "RoleId": 1,
      "UserId": "sample string 2",
      "UniqueEntityId": 3,
      "UserPkId": 1,
      "DataEntityId": 1,
      "Role": {
        "Id": 1,
        "ApplicationId": 1,
        "Name": "sample string 2",
        "RoleId": "sample string 3",
        "Application": {
          "Id": 1,
          "ApplicationName": "sample string 2"
        }
      }
    },
    {
      "Id": 1,
      "RoleId": 1,
      "UserId": "sample string 2",
      "UniqueEntityId": 3,
      "UserPkId": 1,
      "DataEntityId": 1,
      "Role": {
        "Id": 1,
        "ApplicationId": 1,
        "Name": "sample string 2",
        "RoleId": "sample string 3",
        "Application": {
          "Id": 1,
          "ApplicationName": "sample string 2"
        }
      }
    }
  ],
  "DataEntityProcesses": [
    {
      "Id": 1,
      "DataEntityId": 2,
      "ProcessId": 3,
      "ProcessRunId": 4,
      "Name": "sample string 5",
      "IsDeleted": true,
      "ProcessRun": {}
    },
    {
      "Id": 1,
      "DataEntityId": 2,
      "ProcessId": 3,
      "ProcessRunId": 4,
      "Name": "sample string 5",
      "IsDeleted": true,
      "ProcessRun": {}
    }
  ],
  "DataEntityForms": [
    {
      "Id": 1,
      "DataEntityId": 1,
      "FormId": 2,
      "IsDeleted": true
    },
    {
      "Id": 1,
      "DataEntityId": 1,
      "FormId": 2,
      "IsDeleted": true
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'DOMDM.WebApi.Models.DataEntityEndpoint' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'DOMDM.WebApi.Models.DataEntityEndpoint' contains cycles and cannot be serialized if reference tracking is disabled.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataEntity'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.