Patch v2workspaces apps

Configure an app

PATCH /v2/workspaces/{workspaceId}/apps/{slug}

cURL

cURL

curl --request PATCH \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appSlug": "<string>",
  "appName": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "appVersion": "<string>",
  "slug": "<string>",
  "disabled": true,
  "labels": [
    "<string>"
  ],
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "config": "<unknown>"
}
'

import requests

url = "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}"

payload = {
    "appSlug": "<string>",
    "appName": {
        "fr": "Bonjour",
        "en": "Hello"
    },
    "appVersion": "<string>",
    "slug": "<string>",
    "disabled": True,
    "labels": ["<string>"],
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "updatedBy": "<string>",
    "createdBy": "<string>",
    "checksum": "<string>",
    "config": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    appSlug: '<string>',
    appName: {fr: 'Bonjour', en: 'Hello'},
    appVersion: '<string>',
    slug: '<string>',
    disabled: true,
    labels: ['<string>'],
    updatedAt: '<string>',
    createdAt: '<string>',
    updatedBy: '<string>',
    createdBy: '<string>',
    checksum: '<string>',
    config: '<unknown>'
  })
};

fetch('https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'appSlug' => '<string>',
    'appName' => [
        'fr' => 'Bonjour',
        'en' => 'Hello'
    ],
    'appVersion' => '<string>',
    'slug' => '<string>',
    'disabled' => true,
    'labels' => [
        '<string>'
    ],
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'updatedBy' => '<string>',
    'createdBy' => '<string>',
    'checksum' => '<string>',
    'config' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}"

	payload := strings.NewReader("{\n  \"appSlug\": \"<string>\",\n  \"appName\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"appVersion\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"disabled\": true,\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"config\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appSlug\": \"<string>\",\n  \"appName\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"appVersion\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"disabled\": true,\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"config\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"appSlug\": \"<string>\",\n  \"appName\": {\n    \"fr\": \"Bonjour\",\n    \"en\": \"Hello\"\n  },\n  \"appVersion\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"disabled\": true,\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"createdBy\": \"<string>\",\n  \"checksum\": \"<string>\",\n  \"config\": \"<unknown>\"\n}"

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

200

{
  "appSlug": "<string>",
  "appName": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "appVersion": "<string>",
  "slug": "<string>",
  "disabled": true,
  "labels": [
    "<string>"
  ],
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "config": "<unknown>"
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

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

Path Parameters

workspaceId · string · required

Workspace id

slug · string · required

App instance slug

Body

application/json

appSlug · string · required

App unique id

appName · object string

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

appVersion · string

Defaults to the latest known app version

slug · string

Unique & human readable id across current workspace's appInstances, which will be used to call this app automations

disabled · boolean

If disabled, this appInstance will be ignored during execution

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string

checksum · string

config · any

Response

200

application/json

Success Response

appSlug · string · required

App unique id

appName · object string

Show child attributes

Example:

{ "fr": "Bonjour", "en": "Hello" }

appVersion · string

Defaults to the latest known app version

slug · string

Unique & human readable id across current workspace's appInstances, which will be used to call this app automations

disabled · boolean

If disabled, this appInstance will be ignored during execution

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string

checksum · string

config · any