Directory

User artifacts such as data flows, library nodes, and scheduled tasks can be organized in directories.

Get a list of directories

GET request returns the list of directories in the specified container. The container may be a directory, workspace or tenant. The response can be filtered by directory name.

Path Parameters

None

Request Parameters

Parameter Description

Parameter	Description
`container`	The container locator of the requested directories. This can be a tenant, workspace or directory.
`fields`	Specifies the fields to return in the response. One or more of `objects` or `metadata`. Defaults to `objects`
`filter`	An optional FIQL filter expression. Supports searching by the 'name' attribute. For example `filter=name=='Object Name'`
`ltk`	The authentication token.

container

The container locator of the requested directories. This can be a tenant, workspace or directory.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

filter

An optional FIQL filter expression. Supports searching by the 'name' attribute. For example filter=name=='Object Name'

ltk

The authentication token.

Response Fields

Path Type Description

Path	Type	Description
`data.objects[].locator`	`String`	The object resource locator of the requested directory.
`status`	`String`	Status of the response. One of: `OK`, `ERROR`, `SKIPPED` or `ASYNC`
`data.objects[].object.id`	`String`	The identity of the directory. It must be unique and will be allocated if not specified at creation.
`data.objects[].object.name`	`String`	The name of the directory.
`data.objects[].object.description`	`String`	Optional description of directory.

data.objects[].locator

String

The object resource locator of the requested directory.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the directory. It must be unique and will be allocated if not specified at creation.

data.objects[].object.name

String

The name of the directory.

data.objects[].object.description

String

Optional description of directory.

Example request

GET /api/v3/directories?container=object:!tenant:defaultTenant~directory:workspace-id&fields=object&filter=name%3D%3D'Directory%20Name'&ltk=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 529

{
  "status" : "OK",
  "data" : {
    "objects" : [ {
      "locator" : "object:!tenant:defaultTenant~directory:directory-id-001",
      "object" : {
        "id" : "directory-id-001",
        "name" : "First Directory",
        "description" : "Description of Directory"
      }
    }, {
      "locator" : "object:!tenant:defaultTenant~directory:directory-id-002",
      "object" : {
        "id" : "directory-id-002",
        "name" : "Second Directory",
        "description" : "Description of Directory"
      }
    } ]
  }
}