/r/{repoId}/structures/{id}

GET
https://sample-api.d-velop.cloud
Retrieving a structure rule
In the response, you receive the detailed information about the specified structure rule.
Parameters
repoId/string/required
The unique ID of the repository.
id/string/required
The unique ID of the structure rule.
Responses
200
The structure rule was determined successfully.
Content
Media type: application/json
{
  "child": {
    "minLength": 1,
    "type": "string",
    "description": "The parent category id to which a document or dossier is to be linked.",
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "createSiblingDossiers": {
    "type": "boolean",
    "description": "All child dossiers with the same parent dossier are also created automatically when the selected child dossier is created.",
    "default": false
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the structure rule.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "inheritance": {
    "type": "array",
    "items": {
      "required": [
        "propertyId",
        "type"
      ],
      "type": "object",
      "properties": {
        "propertyId": {
          "minLength": 1,
          "type": "string",
          "description": "The ID of a property. This property must be available in both the parent and child category.\r\nIn addition, this property must not have been defined yet under recognition.",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "type": {
          "minLength": 1,
          "type": "string",
          "description": "Indicates the type of inheritance.\r\nFROM_CHILD_TO_PARENT: The properties of the parent category are transferred to the newly created elements of the child category.\r\nFROM_PARENT_TO_CHILD: When automatically creating a dossier of the parent category, the properties of the element of the child category are applied.",
          "example": "FROM_CHILD_TO_PARENT | FROM_PARENT_TO_CHILD"
        }
      },
      "additionalProperties": false,
      "description": "An inheritance object describes a property that is inherited during a link.\r\nIf a link is made using a recognition property, the values of the properties specified under Inheritance are inherited from the parent object to the child object."
    },
    "description": "A list of properties whose values are transferred from the parent element to the child element. If a property in the child element already has a value for the property, it is not transferred from the parent element.",
    "nullable": true
  },
  "parent": {
    "minLength": 1,
    "type": "string",
    "description": "The parent category id to which a document or dossier is to be linked.",
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "recognition": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "childId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in the child category.\r\nMust be set if you want to use a property for linking that is only defined in the child category.\r\n(required if propertyId is empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "parentId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in the parent category.\r\nMust be set if you want to use a property for linking that is only defined in the parent category.\r\n(required if propertyId is empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "propertyId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in both the parent and child category.\r\n(required if parentId and childId are empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        }
      },
      "additionalProperties": false,
      "description": "A Recognition object describes a property or combination of properties that is used to link the parent to child.\r\nIt is not necessary for this property to exist in both the parent and child categories.\r\nDifferent properties can be combined with each other.\r\nIf the value of these properties is identical in both objects, a corresponding structure is created in the system."
    },
    "description": "A list of identification properties. If these properties are the same in a parent element and a child element, they are linked to each other."
  }
}
Media type: application/hal+json
{
  "child": {
    "minLength": 1,
    "type": "string",
    "description": "The parent category id to which a document or dossier is to be linked.",
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "createSiblingDossiers": {
    "type": "boolean",
    "description": "All child dossiers with the same parent dossier are also created automatically when the selected child dossier is created.",
    "default": false
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the structure rule.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "inheritance": {
    "type": "array",
    "items": {
      "required": [
        "propertyId",
        "type"
      ],
      "type": "object",
      "properties": {
        "propertyId": {
          "minLength": 1,
          "type": "string",
          "description": "The ID of a property. This property must be available in both the parent and child category.\r\nIn addition, this property must not have been defined yet under recognition.",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "type": {
          "minLength": 1,
          "type": "string",
          "description": "Indicates the type of inheritance.\r\nFROM_CHILD_TO_PARENT: The properties of the parent category are transferred to the newly created elements of the child category.\r\nFROM_PARENT_TO_CHILD: When automatically creating a dossier of the parent category, the properties of the element of the child category are applied.",
          "example": "FROM_CHILD_TO_PARENT | FROM_PARENT_TO_CHILD"
        }
      },
      "additionalProperties": false,
      "description": "An inheritance object describes a property that is inherited during a link.\r\nIf a link is made using a recognition property, the values of the properties specified under Inheritance are inherited from the parent object to the child object."
    },
    "description": "A list of properties whose values are transferred from the parent element to the child element. If a property in the child element already has a value for the property, it is not transferred from the parent element.",
    "nullable": true
  },
  "parent": {
    "minLength": 1,
    "type": "string",
    "description": "The parent category id to which a document or dossier is to be linked.",
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "recognition": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "childId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in the child category.\r\nMust be set if you want to use a property for linking that is only defined in the child category.\r\n(required if propertyId is empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "parentId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in the parent category.\r\nMust be set if you want to use a property for linking that is only defined in the parent category.\r\n(required if propertyId is empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "propertyId": {
          "type": "string",
          "description": "The ID of a property. This property must be available in both the parent and child category.\r\n(required if parentId and childId are empty)",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        }
      },
      "additionalProperties": false,
      "description": "A Recognition object describes a property or combination of properties that is used to link the parent to child.\r\nIt is not necessary for this property to exist in both the parent and child categories.\r\nDifferent properties can be combined with each other.\r\nIf the value of these properties is identical in both objects, a corresponding structure is created in the system."
    },
    "description": "A list of identification properties. If these properties are the same in a parent element and a child element, they are linked to each other."
  }
}
404
The structure rule 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/structures/ID', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));