Get all actions for a model - Dalus Documentation

Get all actions for a model

curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/actions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:3000/api/models/{modelId}/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/models/{modelId}/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/actions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "label": "<string>",
    "scriptName": "<string>",
    "inputIds": [
      "<string>"
    ],
    "outputIds": [
      "<string>"
    ],
    "variableOrder": [
      "<string>"
    ],
    "successCriteria": [
      "<string>"
    ],
    "failureModes": [
      "<string>"
    ],
    "notes": "<string>"
  }
]

GET

/

api

/

models

/

{modelId}

/

actions

Get all actions for a model

curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/actions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:3000/api/models/{modelId}/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/models/{modelId}/actions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/actions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "label": "<string>",
    "scriptName": "<string>",
    "inputIds": [
      "<string>"
    ],
    "outputIds": [
      "<string>"
    ],
    "variableOrder": [
      "<string>"
    ],
    "successCriteria": [
      "<string>"
    ],
    "failureModes": [
      "<string>"
    ],
    "notes": "<string>"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

modelId

string<uuid>

required

ID of the model

Query Parameters

type

string

Filter actions by type

Response

List of actions

label

string

required

The label of the action

scriptName

string

required

The name of the script file

inputIds

string[]

required

The IDs of the inputs of the action

outputIds

string[]

required

The IDs of the outputs of the action

variableOrder

string[]

The combined ordering of input and output variable IDs

successCriteria

string[]

Array of success criteria for the action

failureModes

string[]

Array of potential failure modes for the action

notes

string

Additional notes about the action