> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt.

# Get Workflow Form

GET /v1/workflow/{form_id}/form

Return the v1 input form of an API workflow, looked up by its stable form ID.

Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/services/temporal/temporal-api/workflow/get-workflow-form

## Authentication

- `Authorization` header (bearer token, required) — Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

## Request

### Path parameters

- `form_id` (string, required) — Stable lowercase kebab-case workflow form identifier.

## Response

### 200

Successful Response

- `requires` (list of string, required)
- `schema` (map from string to any, required)
- `ui_schema` (WorkflowFormUiSchema, required) — The supported subset of an RJSF uiSchema: root options plus one entry per top-level schema property.
- `ui_schema_version` (integer, required)

## Errors

### 404 Not Found Error

No browser form is available for this workflow.

- `detail` (string, required)

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 503 Service Unavailable Error

The workflow's third-party form failed contract validation.

- `detail` (WorkflowFormUnavailableDetail, required) — Sanitized diagnostic for an unavailable third-party workflow form.

## Types

### WorkflowFormUiSchema

The supported subset of an RJSF uiSchema: root options plus one entry per top-level schema property.

- `ui:globalOptions` (WorkflowFormUiSchemaUiGlobalOptions, optional) — Rendering options applied to the whole form.
- `ui:order` (list of string, optional) — Top-level property rendering order; an optional * inserts unlisted properties.
- `ui:submitButtonOptions` (WorkflowFormUiSchemaUiSubmitButtonOptions, optional) — Submit-button presentation options.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `ctx` (ValidationErrorCtx, optional)
- `input` (any, optional)

### WorkflowFormUnavailableDetail

Sanitized diagnostic for an unavailable third-party workflow form.

- `code` ("workflow_form_unavailable", required)
- `message` (string, required)
- `plugin` (string, required)
- `workflow` (string, required)

### WorkflowFormUiSchemaUiGlobalOptions

Rendering options applied to the whole form.

- `exclusiveGroups` (list of WorkflowFormUiSchemaUiGlobalOptionsExclusiveGroupsItems, optional) — Mutually exclusive input modes. A value in one mode disables and clears the others.
- `exclusiveGroupsEmptyMessage` (string, optional) — Optional form-level validation message displayed when every required exclusive input mode is empty.
- `fieldComparisons` (list of WorkflowFormUiSchemaUiGlobalOptionsFieldComparisonsItems, optional) — Client-side comparisons between projected numeric fields.
- `hideSchemaDescriptions` (boolean, optional) — Hide descriptions inherited from the projected input schema.

### WorkflowFormUiSchemaUiSubmitButtonOptions

Submit-button presentation options.

- `submitText` (string, optional) — Text displayed on the submit button.

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

### WorkflowFormUiSchemaUiGlobalOptionsExclusiveGroupsItems

One input mode in a mutually exclusive interaction. fields are projected properties; deviceFilters includes the non-model filters rendered by named device fields.

- any
- any

### WorkflowFormUiSchemaUiGlobalOptionsFieldComparisonsItems

Client-side comparison between two projected numeric fields.

- `left` (string, required) — Projected numeric field that receives the validation error.
- `message` (string, required) — Validation message displayed when the comparison fails.
- `operator` (any, required) — Comparison the left value must satisfy against the right value.
- `right` (string, required) — Projected numeric field compared against the left value.

## Examples

**Response**

```json
{
  "requires": [
    "string"
  ],
  "schema": {},
  "ui_schema": {
    "ui:globalOptions": {
      "exclusiveGroups": [
        null
      ],
      "exclusiveGroupsEmptyMessage": "string",
      "fieldComparisons": [
        {
          "left": "string",
          "message": "string",
          "operator": null,
          "right": "string"
        }
      ],
      "hideSchemaDescriptions": true
    },
    "ui:order": [
      "string"
    ],
    "ui:submitButtonOptions": {
      "submitText": "string"
    }
  },
  "ui_schema_version": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/v1/workflow/form_id/form"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/workflow/form_id/form';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.example.com/v1/workflow/form_id/form"

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workflow/form_id/form")

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

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

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflow/form_id/form")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/v1/workflow/form_id/form', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/v1/workflow/form_id/form");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/workflow/form_id/form")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```