/r/{repoId}/objectmanagement/properties/{id}

GET
https://sample-api.d-velop.cloud
Retrieving a property
In the response, you receive the detailed information about the specified property.
Parameters
repoId/string/required
The unique ID of the repository.
id/string/required
The unique ID of the property.
Responses
200
The property was determined successfully.
Content
Media type: application/json
{
  "dataSetId": {
    "type": "string",
    "description": "The ID of a linked dataset.\r\nCan only be applied to properties of this type: STRING, NUMERIC, CURRENCY, DATE",
    "nullable": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "dataType": {
    "minLength": 1,
    "type": "string",
    "description": "The data type of the property.\r\nSTRING: Text\r\nCURRENCY: Currency\r\nNUMERIC: Number\r\nDATE: Date\r\nDATETIME: Date and time",
    "example": "STRING | CURRENCY | NUMERIC | DATE | DATETIME"
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the property.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "isMultiValue": {
    "type": "boolean",
    "description": "Indicates whether the property has one of multiple values.",
    "default": false
  },
  "isSystemProperty": {
    "type": "boolean",
    "description": "Indicates whether the property has been created by the system.",
    "default": false,
    "readOnly": true
  },
  "maxValue": {
    "type": "integer",
    "description": "The smallest value this property can take.\r\nCan only be applied to properties of this type: NUMERIC, CURRENCY",
    "format": "int32",
    "nullable": true,
    "example": 10
  },
  "minValue": {
    "type": "integer",
    "description": "The smallest value this property can take.\r\nCan only be applied to properties of this type: NUMERIC, CURRENCY",
    "format": "int32",
    "nullable": true,
    "example": 1
  },
  "name": {
    "type": "object",
    "additionalProperties": {
      "type": "string",
      "nullable": true
    },
    "description": "The display name of the property. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language.",
    "example": {
      "en": "Bill"
    }
  },
  "readOnly": {
    "type": "boolean",
    "description": "A read-only property indicating whether a property has been predefined by the system and cannot be changed.",
    "default": false,
    "readOnly": true
  },
  "validationRegEx": {
    "type": "string",
    "description": "Regular expression for validation of the input (POSIX basic regular expression syntax).\r\nCan only be applied to properties of this type: STRING",
    "nullable": true,
    "example": "\\d+(\\.\\d\\d)?"
  }
}
Media type: application/hal+json
{
  "dataSetId": {
    "type": "string",
    "description": "The ID of a linked dataset.\r\nCan only be applied to properties of this type: STRING, NUMERIC, CURRENCY, DATE",
    "nullable": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "dataType": {
    "minLength": 1,
    "type": "string",
    "description": "The data type of the property.\r\nSTRING: Text\r\nCURRENCY: Currency\r\nNUMERIC: Number\r\nDATE: Date\r\nDATETIME: Date and time",
    "example": "STRING | CURRENCY | NUMERIC | DATE | DATETIME"
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the property.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "isMultiValue": {
    "type": "boolean",
    "description": "Indicates whether the property has one of multiple values.",
    "default": false
  },
  "isSystemProperty": {
    "type": "boolean",
    "description": "Indicates whether the property has been created by the system.",
    "default": false,
    "readOnly": true
  },
  "maxValue": {
    "type": "integer",
    "description": "The smallest value this property can take.\r\nCan only be applied to properties of this type: NUMERIC, CURRENCY",
    "format": "int32",
    "nullable": true,
    "example": 10
  },
  "minValue": {
    "type": "integer",
    "description": "The smallest value this property can take.\r\nCan only be applied to properties of this type: NUMERIC, CURRENCY",
    "format": "int32",
    "nullable": true,
    "example": 1
  },
  "name": {
    "type": "object",
    "additionalProperties": {
      "type": "string",
      "nullable": true
    },
    "description": "The display name of the property. Key pairs from the ID of the language (ISO 639-1 and RFC-3066) and the display name in the corresponding language.",
    "example": {
      "en": "Bill"
    }
  },
  "readOnly": {
    "type": "boolean",
    "description": "A read-only property indicating whether a property has been predefined by the system and cannot be changed.",
    "default": false,
    "readOnly": true
  },
  "validationRegEx": {
    "type": "string",
    "description": "Regular expression for validation of the input (POSIX basic regular expression syntax).\r\nCan only be applied to properties of this type: STRING",
    "nullable": true,
    "example": "\\d+(\\.\\d\\d)?"
  }
}
404
The property with the specified ID could not be determined.
Content
Media type: application/json
{
  "code": {
    "type": "integer",
    "format": "int32",
    "example": 240100
  },
  "reason": {
    "type": "string",
    "nullable": true,
    "example": "Reason why the request failed."
  }
}
Media type: application/hal+json
{
  "code": {
    "type": "integer",
    "format": "int32",
    "example": 240100
  },
  "reason": {
    "type": "string",
    "nullable": true,
    "example": "Reason why the request failed."
  }
}
Show operation

Language

const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch('https://example.com/dmsconfig/r/REPOID/objectmanagement/properties/ID', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));