Get attachment

v1.0.0

Gets information about a registered attachment.

⚠️ To understand the specific syntax for Assembly Options attachments, read the documentation.

Response body example

json

{
  "Id": 8,
  "Name": "Test",
  "IsRequired": true,
  "IsActive": true,
  "Domains": [
    {
      "FieldName": "Basic test",
      "MaxCaracters": "",
      "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic"
    },
    {
      "FieldName": "teste",
      "MaxCaracters": "",
      "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium"
    }
  ]
}

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "Content-Type": {
      "type": "string"
    },
    "attachmentid": {
      "type": "string"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "attachmentid"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "Domains",
    "Id",
    "IsActive",
    "IsRequired",
    "Name"
  ],
  "properties": {
    "Domains": {
      "type": "array",
      "description": "List of characteristics related to the attachment.",
      "items": {
        "type": "object",
        "properties": {
          "DomainValues": {
            "type": "string",
            "description": "Allowed key values."
          },
          "FieldName": {
            "type": "string",
            "description": "Attachment key name."
          },
          "MaxCaracters": {
            "type": "string",
            "description": "Maximum number of characters in the attachment key."
          }
        }
      }
    },
    "Id": {
      "type": "integer",
      "description": "Attachment ID."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the attachment is active or not."
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the attachment is required or not."
    },
    "Name": {
      "type": "string",
      "description": "Attachment Name."
    }
  }
}