Retrieve

Get

client.Directories.Get(ctx, appID) (*DirectoryViewDirectoryViewExpandedarrayDirectoryGetResponse, error)

get/api/v1/directories/{app_id}

Get a directory by app_id.

Parameters

appIDstring

The appId field.

Returns

DirectoryGetResponsestruct

The Directory Service Get Response returns a directory view with a directory and JSONPATHs indicating the location in the expanded array that items are expanded as indicated by the expand mask in the request.

Hide ParametersShow Parameters

DirectoryViewAppPathstringDirectoryDirectoryViewDirectoryDirectoryView

optional

The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.

Expandedarray

optional

[]DirectoryGetResponseExpanded

List of serialized related objects.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  directory, err := client.Directories.Get(context.TODO(), "app_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", directory.DirectoryView)
}

200 Example

{
  "directoryView": {
    "appPath": "appPath",
    "directory": {}
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}