d.velop DMSApp

https://help.d-velop.de/dev/documentation/dms-app
Admin
DMSApp is the core HTTP interface within the d.ecs architecture system, providing essential...
Tokens:2,900
Snippets:33
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /r

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves a list of all repositories.

```APIDOC
## GET /r

### Description
Get all repositories available in the system.

### Method
GET

### Endpoint
/r
```

--------------------------------

### GET /r

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves a list of all available repositories configured in the d.3ecm system.

```APIDOC
## GET /r

### Description
Retrieves a list of all available repositories. This is required to obtain the repository ID for further operations.

### Method
GET

### Endpoint
/r

### Response
#### Success Response (200)
- **repositories** (array) - List of repository objects

#### Response Example
{
  "repositories": [
    {
      "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27",
      "name": "Contoso (A)"
    }
  ]
}
```

--------------------------------

### GET /r/{repositoryId}/objdef

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves the object definitions for a specific repository.

```APIDOC
## GET /r/{repositoryId}/objdef

### Description
Retrieves the object definitions associated with the specified repository.

### Method
GET

### Endpoint
/r/{repositoryId}/objdef

### Parameters
#### Path Parameters
- **repositoryId** (string) - Required - The unique identifier for the repository.

### Response
#### Success Response (200)
- **objectDefinitions** (array) - List of object definitions
- **count** (integer) - Total number of definitions

#### Response Example
{
  "objectDefinitions": [
    {
      "id": "5",
      "uniqueId": "d42018fc-ab90-4ca5-807c-5259152fd3ab",
      "displayName": "Sample category1"
    }
  ],
  "count": 1
}
```

--------------------------------

### Example of a failed HTTP request response

Source: https://help.d-velop.de/dev/documentation/dms-app

Shows the structure of a JSON error response returned when an HTTP request fails.

```http
HTTP/1.1 400 BadRequest
{
    "reason": "10019: Missing value for a mandatory property.",
    "severity": 1,
}
```

--------------------------------

### GET /r/{repositoryId}

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves details for a specific repository using its unique identifier.

```APIDOC
## GET /r/{repositoryId}

### Description
Retrieves the details of a specific repository identified by the provided repository ID.

### Method
GET

### Endpoint
/r/{repositoryId}

### Parameters
#### Path Parameters
- **repositoryId** (string) - Required - The unique identifier for the repository.

### Response
#### Success Response (200)
- **id** (string) - The repository ID
- **name** (string) - The repository name

#### Response Example
{
  "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27",
  "name": "Contoso (A)"
}
```

--------------------------------

### GET /r/{repositoryId}/sf/{searchFilterId}

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves an existing search filter by its ID.

```APIDOC
## GET /r/{repositoryId}/sf/{searchFilterId}

### Description
Retrieves the details of a stored search filter.

### Method
GET

### Endpoint
/r/{repositoryId}/sf/{searchFilterId}
```

--------------------------------

### Retrieve translated DMS object

Source: https://help.d-velop.de/dev/documentation/dms-app

Perform a GET request with a sourceId parameter to retrieve an object with translated categories and properties.

```json
{
  "id": "some-dms-object",
  "sourceProperties": [
    {
      "key": "deliveryNoteNumber",
      "value": "48529321"
    },
    {
      "key": "supplierId",
      "value": "8562851"
        },
    ...
  ],
  "sourceCategories": [
    "deliveryNote"
  ],
  "_links": {...},
  "_embedded": {...}
}
```

--------------------------------

### Fetch all repositories

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves a list of all available repositories for the authenticated tenant.

```javascript
fetch('https://my-tenant.d-velop.cloud/dms/r', {
  headers: {
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  }
})
```

```json
{
  "repositories": [
    {
      "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27",
      "name": "Contoso (A)"
    },
    {
      "id": "39b68b01-0428-5049-8d80-c8c0750ba885",
      "name": "Contoso (B)"
    }
  ]
}
```

--------------------------------

### Create a mapping source

Source: https://help.d-velop.de/dev/documentation/dms-app

Define a source with categories and properties to be mapped by a tenant administrator.

```json
{
  "sourceId": "/cool-supplier-app/sources/delivery-notes",
  "categories": [
    {
      "key": "deliveryNote",
      "displayName": "Delivery Note"
    }
  ],
  "properties": [
    {
      "key": "deliveryNoteNumber",
      "displayName": "Delivery Note Number"
    },
    {
      "key": "supplierId",
      "displayName": "Supplier No."
    }
  ]
}
```

--------------------------------

### Fetch repository object definitions

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves the object definitions associated with a specific repository.

```javascript
fetch('https://my-tenant.d-velop.cloud/dms/r/{repositoryId}/objdef', {
  headers: {
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  }
})
```

```json
{
  "objectDefinitions": [
    {
      "id": "5",
      "uniqueId": "d42018fc-ab90-4ca5-807c-5259152fd3ab",
      "displayName": "Sample category1",
      "writeAccess": true,
      "objectType": 0,
      "propertyFields": [
        {
          "id": "10044",
          "uniqueId": "1ac35664-e204-4bee-8aee-378abbae78ae",
          "docFieldId": 38,
          "displayName": "Sample property1",
          "dataType": 0
        }
      ]
    }
  ],
  "count": 1
}
```

--------------------------------

### Fetch a specific repository

Source: https://help.d-velop.de/dev/documentation/dms-app

Retrieves details for a single repository using its unique repositoryId.

```javascript
fetch('https://my-tenant.d-velop.cloud/dms/r/{repositoryId}', {
  headers: {
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  }
})
```

```json
{
  "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27",
  "name": "Contoso (A)"
}
```

--------------------------------

### Extensions Operations

Source: https://help.d-velop.de/dev/documentation/dms-app

Operations for managing system extensions.

```APIDOC
## GET /extensions
## POST /extensions
## DELETE /extensions
## DELETE /extensions/{extensionId}
```

--------------------------------

### PUT /r/{repositoryId}/sf/{searchFilterId}

Source: https://help.d-velop.de/dev/documentation/dms-app

Updates an existing search filter.

```APIDOC
## PUT /r/{repositoryId}/sf/{searchFilterId}

### Description
Updates the criteria of an existing search filter.

### Method
PUT

### Endpoint
/r/{repositoryId}/sf/{searchFilterId}
```

--------------------------------

### POST /r/{repositoryId}/sf

Source: https://help.d-velop.de/dev/documentation/dms-app

Creates a new search filter by storing search criteria under a generated ID.

```APIDOC
## POST /r/{repositoryId}/sf

### Description
Stores search criteria (full-text term, categories, properties, and sort order) under a generated ID for a limited time.

### Method
POST

### Endpoint
/r/{repositoryId}/sf
```

--------------------------------

### DmsObjects Operations

Source: https://help.d-velop.de/dev/documentation/dms-app

Operations for managing DMS objects, versions, and relationships.

```APIDOC
## GET /r/{repositoryId}/srm
## POST /r/{repositoryId}/blob/chunk
## POST /r/{repositoryId}/o2m
## GET /r/{repositoryId}/o2m/{dmsObjectId}
## PUT /r/{repositoryId}/o2m/{dmsObjectId}
## DELETE /r/{repositoryId}/o2m/{dmsObjectId}
## GET /r/{repositoryId}/o2m/{dmsObjectId}/v
## GET /r/{repositoryId}/o2m/{dmsObjectId}/v/{versionId}
## PUT /r/{repositoryId}/o2m/{dmsObjectId}/v/current
## POST /r/{repositoryId}/o2m/{parentDmsObjectId}/children
## DELETE /r/{repositoryId}/o2m/{parentDmsObjectId}/children/{childDmsObjectId}
## GET /r/{repositoryId}/o2m/{dmsObjectId}/n
## POST /r/{repositoryId}/o2m/{dmsObjectId}/n
```

--------------------------------

### Specify Origin header for write operations

Source: https://help.d-velop.de/dev/documentation/dms-app

Include the Origin header in POST, PUT, DELETE, and PATCH requests to prevent CSRF attacks. The value must match the calling URL without the path.

```http
PUT /dms/sampleuri
Origin: https://samplehost
```

--------------------------------

### DELETE /r/{repositoryId}/sf/{searchFilterId}

Source: https://help.d-velop.de/dev/documentation/dms-app

Deletes a search filter by its ID.

```APIDOC
## DELETE /r/{repositoryId}/sf/{searchFilterId}

### Description
Removes a stored search filter.

### Method
DELETE

### Endpoint
/r/{repositoryId}/sf/{searchFilterId}
```
Tokens:
Raw