Create Surface

curl --request POST \
  --url https://workflow.eu.confidence.dev/v1/surfaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "name": "<string>",
  "description": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "reviews": {
    "mandatory": true,
    "reviewers": [
      "<string>"
    ]
  },
  "metricConfig": {
    "mandatoryMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "associatedMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "metrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ]
  },
  "automatedActions": [
    {
      "trigger": {
        "activityTrigger": {
          "kind": "<string>",
          "resource": "<string>"
        },
        "stateTrigger": {
          "state": "<string>",
          "resource": "<string>"
        }
      },
      "action": {
        "executeFunctionAction": {
          "function": "<string>",
          "parameters": {}
        },
        "transitionAction": {
          "action": "<string>",
          "parameters": {}
        }
      }
    }
  ],
  "stakeholders": [
    {
      "identity": "<string>",
      "role": "<string>"
    }
  ]
}
'

import requests

url = "https://workflow.eu.confidence.dev/v1/surfaces"

payload = {
    "displayName": "<string>",
    "name": "<string>",
    "description": "<string>",
    "labels": [{}],
    "owner": "<string>",
    "reviews": {
        "mandatory": True,
        "reviewers": ["<string>"]
    },
    "metricConfig": {
        "mandatoryMetrics": [
            {
                "metric": "<string>",
                "successMetric": { "minimumDetectableEffect": { "value": "<string>" } },
                "guardrailMetric": { "nonInferiorityMargin": { "value": "<string>" } }
            }
        ],
        "associatedMetrics": [
            {
                "metric": "<string>",
                "successMetric": { "minimumDetectableEffect": { "value": "<string>" } },
                "guardrailMetric": { "nonInferiorityMargin": { "value": "<string>" } }
            }
        ],
        "metrics": [
            {
                "metric": "<string>",
                "successMetric": { "minimumDetectableEffect": { "value": "<string>" } },
                "guardrailMetric": { "nonInferiorityMargin": { "value": "<string>" } }
            }
        ]
    },
    "automatedActions": [
        {
            "trigger": {
                "activityTrigger": {
                    "kind": "<string>",
                    "resource": "<string>"
                },
                "stateTrigger": {
                    "state": "<string>",
                    "resource": "<string>"
                }
            },
            "action": {
                "executeFunctionAction": {
                    "function": "<string>",
                    "parameters": {}
                },
                "transitionAction": {
                    "action": "<string>",
                    "parameters": {}
                }
            }
        }
    ],
    "stakeholders": [
        {
            "identity": "<string>",
            "role": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    name: '<string>',
    description: '<string>',
    labels: [{}],
    owner: '<string>',
    reviews: {mandatory: true, reviewers: ['<string>']},
    metricConfig: {
      mandatoryMetrics: [
        {
          metric: '<string>',
          successMetric: {minimumDetectableEffect: {value: '<string>'}},
          guardrailMetric: {nonInferiorityMargin: {value: '<string>'}}
        }
      ],
      associatedMetrics: [
        {
          metric: '<string>',
          successMetric: {minimumDetectableEffect: {value: '<string>'}},
          guardrailMetric: {nonInferiorityMargin: {value: '<string>'}}
        }
      ],
      metrics: [
        {
          metric: '<string>',
          successMetric: {minimumDetectableEffect: {value: '<string>'}},
          guardrailMetric: {nonInferiorityMargin: {value: '<string>'}}
        }
      ]
    },
    automatedActions: [
      {
        trigger: {
          activityTrigger: {kind: '<string>', resource: '<string>'},
          stateTrigger: {state: '<string>', resource: '<string>'}
        },
        action: {
          executeFunctionAction: {function: '<string>', parameters: {}},
          transitionAction: {action: '<string>', parameters: {}}
        }
      }
    ],
    stakeholders: [{identity: '<string>', role: '<string>'}]
  })
};

fetch('https://workflow.eu.confidence.dev/v1/surfaces', 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://workflow.eu.confidence.dev/v1/surfaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'labels' => [
        [
                
        ]
    ],
    'owner' => '<string>',
    'reviews' => [
        'mandatory' => true,
        'reviewers' => [
                '<string>'
        ]
    ],
    'metricConfig' => [
        'mandatoryMetrics' => [
                [
                                'metric' => '<string>',
                                'successMetric' => [
                                                                'minimumDetectableEffect' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ],
                                'guardrailMetric' => [
                                                                'nonInferiorityMargin' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ]
                ]
        ],
        'associatedMetrics' => [
                [
                                'metric' => '<string>',
                                'successMetric' => [
                                                                'minimumDetectableEffect' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ],
                                'guardrailMetric' => [
                                                                'nonInferiorityMargin' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ]
                ]
        ],
        'metrics' => [
                [
                                'metric' => '<string>',
                                'successMetric' => [
                                                                'minimumDetectableEffect' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ],
                                'guardrailMetric' => [
                                                                'nonInferiorityMargin' => [
                                                                                                                                'value' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'automatedActions' => [
        [
                'trigger' => [
                                'activityTrigger' => [
                                                                'kind' => '<string>',
                                                                'resource' => '<string>'
                                ],
                                'stateTrigger' => [
                                                                'state' => '<string>',
                                                                'resource' => '<string>'
                                ]
                ],
                'action' => [
                                'executeFunctionAction' => [
                                                                'function' => '<string>',
                                                                'parameters' => [
                                                                                                                                
                                                                ]
                                ],
                                'transitionAction' => [
                                                                'action' => '<string>',
                                                                'parameters' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ],
    'stakeholders' => [
        [
                'identity' => '<string>',
                'role' => '<string>'
        ]
    ]
  ]),
  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://workflow.eu.confidence.dev/v1/surfaces"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\",\n  \"reviews\": {\n    \"mandatory\": true,\n    \"reviewers\": [\n      \"<string>\"\n    ]\n  },\n  \"metricConfig\": {\n    \"mandatoryMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"associatedMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"metrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ]\n  },\n  \"automatedActions\": [\n    {\n      \"trigger\": {\n        \"activityTrigger\": {\n          \"kind\": \"<string>\",\n          \"resource\": \"<string>\"\n        },\n        \"stateTrigger\": {\n          \"state\": \"<string>\",\n          \"resource\": \"<string>\"\n        }\n      },\n      \"action\": {\n        \"executeFunctionAction\": {\n          \"function\": \"<string>\",\n          \"parameters\": {}\n        },\n        \"transitionAction\": {\n          \"action\": \"<string>\",\n          \"parameters\": {}\n        }\n      }\n    }\n  ],\n  \"stakeholders\": [\n    {\n      \"identity\": \"<string>\",\n      \"role\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://workflow.eu.confidence.dev/v1/surfaces")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\",\n  \"reviews\": {\n    \"mandatory\": true,\n    \"reviewers\": [\n      \"<string>\"\n    ]\n  },\n  \"metricConfig\": {\n    \"mandatoryMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"associatedMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"metrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ]\n  },\n  \"automatedActions\": [\n    {\n      \"trigger\": {\n        \"activityTrigger\": {\n          \"kind\": \"<string>\",\n          \"resource\": \"<string>\"\n        },\n        \"stateTrigger\": {\n          \"state\": \"<string>\",\n          \"resource\": \"<string>\"\n        }\n      },\n      \"action\": {\n        \"executeFunctionAction\": {\n          \"function\": \"<string>\",\n          \"parameters\": {}\n        },\n        \"transitionAction\": {\n          \"action\": \"<string>\",\n          \"parameters\": {}\n        }\n      }\n    }\n  ],\n  \"stakeholders\": [\n    {\n      \"identity\": \"<string>\",\n      \"role\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://workflow.eu.confidence.dev/v1/surfaces")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\",\n  \"reviews\": {\n    \"mandatory\": true,\n    \"reviewers\": [\n      \"<string>\"\n    ]\n  },\n  \"metricConfig\": {\n    \"mandatoryMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"associatedMetrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"metrics\": [\n      {\n        \"metric\": \"<string>\",\n        \"successMetric\": {\n          \"minimumDetectableEffect\": {\n            \"value\": \"<string>\"\n          }\n        },\n        \"guardrailMetric\": {\n          \"nonInferiorityMargin\": {\n            \"value\": \"<string>\"\n          }\n        }\n      }\n    ]\n  },\n  \"automatedActions\": [\n    {\n      \"trigger\": {\n        \"activityTrigger\": {\n          \"kind\": \"<string>\",\n          \"resource\": \"<string>\"\n        },\n        \"stateTrigger\": {\n          \"state\": \"<string>\",\n          \"resource\": \"<string>\"\n        }\n      },\n      \"action\": {\n        \"executeFunctionAction\": {\n          \"function\": \"<string>\",\n          \"parameters\": {}\n        },\n        \"transitionAction\": {\n          \"action\": \"<string>\",\n          \"parameters\": {}\n        }\n      }\n    }\n  ],\n  \"stakeholders\": [\n    {\n      \"identity\": \"<string>\",\n      \"role\": \"<string>\"\n    }\n  ]\n}"

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

{
  "displayName": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "description": "<string>",
  "labels": [
    {}
  ],
  "deleteTime": {},
  "owner": "<string>",
  "reviews": {
    "mandatory": true,
    "reviewers": [
      "<string>"
    ]
  },
  "metricConfig": {
    "mandatoryMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "associatedMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "metrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ]
  },
  "automatedActions": [
    {
      "trigger": {
        "activityTrigger": {
          "kind": "<string>",
          "resource": "<string>"
        },
        "stateTrigger": {
          "state": "<string>",
          "resource": "<string>"
        }
      },
      "action": {
        "executeFunctionAction": {
          "function": "<string>",
          "parameters": {}
        },
        "pagerdutyAction": {
          "pdKey": "<string>",
          "title": "<string>",
          "description": "<string>"
        },
        "transitionAction": {
          "action": "<string>",
          "parameters": {}
        }
      }
    }
  ],
  "stakeholders": [
    {
      "identity": "<string>",
      "role": "<string>"
    }
  ]
}