Attributions

Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

404

Resource with given ID was not found

application/json

get/dms/attributions/{id}

GET /api/dms/attributions/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "refType": "text",
  "refId": 1,
  "uiSort": 1,
  "uiComment": "text",
  "uiFavorite": false,
  "mainAttribution": true,
  "transformationKeys": [
    "text"
  ],
  "shelfResourceId": 1,
  "publish": true,
  "purpose": "text"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/dms/attributions/{id}

PUT /api/dms/attributions/{id} HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "version": "text",
  "info": {},
  "id": "text",
  "refType": "text",
  "refId": 1,
  "uiSort": 1,
  "uiComment": "text",
  "uiFavorite": false,
  "shelfResourceId": 1,
  "publish": true,
  "purpose": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "refType": "text",
  "refId": 1,
  "uiSort": 1,
  "uiComment": "text",
  "uiFavorite": false,
  "mainAttribution": true,
  "transformationKeys": [
    "text"
  ],
  "shelfResourceId": 1,
  "publish": true,
  "purpose": "text"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/dms/attributions/{id}

DELETE /api/dms/attributions/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

put

Bodyobject · dms-shelf-ShelfDocumentAttribution[]

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

Responses

200

OK

No content

put/dms/attributions/update-all

PUT /api/dms/attributions/update-all HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 2

[]

200

OK

No content

get

Liefert alle Verknüpfungen, die zu einem ERP-Objekt gehören.

Query parameters

refIdinteger · int64Optional

ID des ERP-Objekts

refTypestringOptional

Um was für ein ERP-Objekt handelt es sich?

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

get/dms/attributions

GET /api/dms/attributions HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

200

OK

[]

Create new Resource

post

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refTypestringOptional

type of the referenced object

refIdinteger · int64Optional

id of the referenced object

uiSortinteger · int32Optional

UI-verwaltetes Feld

uiCommentstringOptional

UI-verwaltetes Feld

uiFavoritebooleanOptional

UI-verwaltetes Feld

Default: false

mainAttributionbooleanRead-onlyOptional

Hauptverknüpfung dieser DMS-Ressource

transformationKeysstring[]Read-onlyOptional

Verfügbare Transformationen zum Bild

shelfResourceIdinteger · int64Optional

ID der verknüpften DMS-Ressource

publishbooleanOptional

Soll das Dokument veröffentlicht werden?

purposestringRequired

Art der Beziehung / Verwendungszweck

422

Resource was not valid to process

application/json

post/dms/attributions

POST /api/dms/attributions HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "version": "text",
  "info": {},
  "id": "text",
  "refType": "text",
  "refId": 1,
  "uiSort": 1,
  "uiComment": "text",
  "uiFavorite": false,
  "shelfResourceId": 1,
  "publish": true,
  "purpose": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "refType": "text",
  "refId": 1,
  "uiSort": 1,
  "uiComment": "text",
  "uiFavorite": false,
  "mainAttribution": true,
  "transformationKeys": [
    "text"
  ],
  "shelfResourceId": 1,
  "publish": true,
  "purpose": "text"
}