Released: JSON representation

The default source system is a predefined source system for each d.3 repository which is provided by default by the DMS app. When you provide an extension to DMS functions and do not want to define your own source system, you can use the properties and categories of the d.3 repository with the default source system.

The definition of a default source system and the associated mappings are set by the DMS app. You cannot change mappings for a default source system.

This chapter explains how to retrieve the source system definition for each d.3 repository.

To retrieve the source system definition of a d.3 repository, you must perform the following steps:

Determining the URL for a repository

In the chapter Determining a repository, you can learn how to determine the URL for a repository.

Determine the link relation for retrieving the source system definition of a d.3 repository

The JSON object for a d.3 repository contains the link relation source which you can use to retrieve the source system definition of the d.3 repository.

Response

{
        "_links": {
                "source": {
                        "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source"
                }
        },
        "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Open the URL for the source system definition of a d.3 repository

You need to ensure that you can authenticate yourself for the d.3 repository. Only then you can retrieve the URL. The default source system contains all categories and properties of the d.3 repository regardless of the permissions of the user.

Retrieve the source system definition of the d.3 repository with the previously determined URL as follows:

Request

GET https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source HTTP/1.1
Accept: application/hal+json

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
        "id": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source",
        "displayName": "D3RepositoryName",
        "properties": [
                {
                        "key": "Key0",
                        "type": "String",
                        "displayName": "Sample property1"
                }
        ],
        "categories":[
                {
                        "key": "mycategory1_ID",
                        "displayName": "Sample category1"
                }
        ]
}

Structure of a source

Structure of a category

Structure of a property