Change only the archive scope of a unique constraint, atomically and with its current RowVersion.

PUT

/api/workspace/admin/entity-definitions/{entityDefinitionId}/unique-constraints/{constraintId}

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-definitions/example/unique-constraints/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ArchiveScope\": 1, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        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-definitions/example/unique-constraints/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ArchiveScope":1,"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

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-definitions/example/unique-constraints/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ArchiveScope": 1, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityDefinitionId

required

string

constraintId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Change the archive scope of an existing unique constraint atomically.

object

ArchiveScope

required

integer format: int32

Allowed values: 1 2

RowVersion

required

Current constraint concurrency token.

string format: uuid

Responses

200

application/json

object

Data

Unique constraint configured for one entity definition table.

object

Constraint identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Fields

Ordered participating fields.

Array<object>

nullable

Field entry participating in an entity unique constraint.

object

Field identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Key

Field key.

string

nullable

DisplayName

User-facing field name.

string

nullable

RowVersion

Concurrency token.

string format: uuid

ArchiveScope

required

integer format: int32

Allowed values: 1 2

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "ArchiveScope": 1
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Unique constraint configured for one entity definition table.

object

Constraint identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Fields

Ordered participating fields.

Array<object>

nullable

Field entry participating in an entity unique constraint.

object

Field identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Key

Field key.

string

nullable

DisplayName

User-facing field name.

string

nullable

RowVersion

Concurrency token.

string format: uuid

ArchiveScope

required

integer format: int32

Allowed values: 1 2

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "ArchiveScope": 1
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Unique constraint configured for one entity definition table.

object

Constraint identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Fields

Ordered participating fields.

Array<object>

nullable

Field entry participating in an entity unique constraint.

object

Field identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Key

Field key.

string

nullable

DisplayName

User-facing field name.

string

nullable

RowVersion

Concurrency token.

string format: uuid

ArchiveScope

required

integer format: int32

Allowed values: 1 2

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "ArchiveScope": 1
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Unique constraint configured for one entity definition table.

object

Constraint identifier.

string

nullable

EntityDefinitionId

Entity definition identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Fields

Ordered participating fields.

Array<object>

nullable

Field entry participating in an entity unique constraint.

object

Field identifier.

string

nullable

EntityDefinitionTableId

Owning table identifier.

string

nullable

Key

Field key.

string

nullable

DisplayName

User-facing field name.

string

nullable

RowVersion

Concurrency token.

string format: uuid

ArchiveScope

required

integer format: int32

Allowed values: 1 2

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "ArchiveScope": 1
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Change only the archive scope of a unique constraint, atomically and with its current RowVersion.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated