Creating a Folder (record)

Steps

As a User or Tenant, follow these steps to create a Folder (record) within an existing Drawer (sidedrawer).

You'll need:

• an access token

1. Get fields

Get the Record Subtype Specific Fields.

GET /api/v1/records/records-type/record-type-name/{recordTypeName}/record-subtype/record-subtype-name/{recordSubtypeName}/specific-fields

Example Response

[
  {
    "fieldName": "name",
    "displayValue": [
      {
        "locale": "en-CA",
        "value": "Name",
        "description": ""
      }
    ],
    "validation": {
      "type": "isString",
      "formType": "string",
      "constraints": [
        ""
      ]
    },
    "orderId": 0
  }
]

2. Create Folder

Create a Folder (record).

POST /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records

Example Request Body

{
    "name": "Folder name",
    "recordTypeName": "Hanger name",
    "recordSubtypeName": "Record subtype name",
    "storageLocation": "",
    "description": "",
    "recordDetails": {
        "customFields": []
    }
}

Example Response

{
    "id": "{recordId}",
    "name": "Folder name"
}

3. Get Folders

Return the list of Folders (record).

GET /api/v2/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records?locale={locale}&recordTypeName={recordTypeName}

Example Response

[
    {
        "id": "{recordId}",
        "name": "Folder name",
        "storageLocation": "",
        "description": "",
        "recordSubtype": {
            "id": "{recordSubtypeId}",
            "name": "Record subtype name",
            "logo": "Record subtype logo URL",
            "displayValue": [
                {
                    "locale": "en-CA",
                    "value": "Record subtype name in correct language"
                }
            ]
        },
        "recordType": {
            "name": "Hanger name",
            "logo": "Hanger logo URL",
            "displayValue": [
                {
                    "locale": "en-CA",
                    "value": "Hanger name in correct language"
                }
            ]
        },
        "active": true,
        "updatedAt": "2024-08-09T16:46:25.540Z",
        "lastModifiedBy": "User",
        "editable": true,
        "externalKeys": []
    }
]

4. Get Drawer info

Get information about the Drawer (sidedrawer).

GET /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/home

5. Get created Folder

Get the Folder (record) that you just created.

GET /api/v2/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}

Example Response

{
  "id": "{recordId}",
  "name": "Folder Name",
  "description": "",
  "uniqueReference": "",
  "storageLocation": "",
  "recordSubtypeName": "Name",
  "recordSubtype": {},
  "recordSubtypeOther": "",
  "recordTypeName": "Hanger Name",
  "recordType": {},
  "active": true,
  "recordDetails": {},
  "status": "ACTIVE",
  "updatedAt": "2024-08-09T17:08:41.617Z",
  "filesHistory": [
    {}
  ],
  "userSidedrawerRole": [
    ""
  ],
  "userRecordRole": [
    ""
  ]
}