# Setup API: Routes

## GET /api/setup/actions/{id}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ActionModel":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"navigationParentActionId":{"type":"string","format":"uuid","nullable":true},"permissionParentActionUrl":{"type":"string","nullable":true},"actionIcon":{"type":"string","nullable":true},"actionList":{"type":"string","nullable":true},"actionName":{"type":"string","nullable":true},"actionNameShort":{"type":"string","nullable":true},"actionType":{"type":"string","nullable":true},"actionUrl":{"type":"string","nullable":true},"authorityType":{"type":"string","nullable":true},"authorizationRequirement":{"type":"string","nullable":true},"controllerPath":{"type":"string","nullable":true},"extraBreadcrumb":{"type":"string","nullable":true},"helpUrl":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/setup/actions/{id}":{"get":{"tags":["Setup API: Routes"],"parameters":[{"name":"action","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ActionModel"}}}}}}}}}
```

## PUT /api/setup/actions/{id}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ModifyAction":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"navigationParentActionId":{"type":"string","format":"uuid","nullable":true},"permissionParentActionId":{"type":"string","format":"uuid","nullable":true},"actionIcon":{"type":"string","nullable":true},"actionList":{"type":"string","nullable":true},"actionName":{"type":"string","nullable":true},"actionNameShort":{"type":"string","nullable":true},"actionType":{"type":"string","nullable":true},"actionUrl":{"type":"string","nullable":true},"authorityType":{"type":"string","nullable":true},"authorizationRequirement":{"type":"string","nullable":true},"controllerPath":{"type":"string","nullable":true},"extraBreadcrumb":{"type":"string","nullable":true},"helpUrl":{"type":"string","nullable":true}},"additionalProperties":false},"ValidationFailure":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"extensions":{"type":"object","additionalProperties":{"nullable":true},"nullable":true}},"additionalProperties":false}}},"paths":{"/api/setup/actions/{id}":{"put":{"tags":["Setup API: Routes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ModifyAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/ModifyAction"}},"text/json":{"schema":{"$ref":"#/components/schemas/ModifyAction"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ModifyAction"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailure"}}}},"404":{"description":"Not Found"}}}}}}
```

## DELETE /api/setup/actions/{id}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}}},"paths":{"/api/setup/actions/{id}":{"delete":{"tags":["Setup API: Routes"],"parameters":[{"name":"action","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"}}}}}}
```

## HEAD /api/setup/actions/{id}

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}}},"paths":{"/api/setup/actions/{id}":{"head":{"tags":["Setup API: Routes"],"parameters":[{"name":"action","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}}}}
```

## GET /api/setup/actions/count

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}}},"paths":{"/api/setup/actions/count":{"get":{"tags":["Setup API: Routes"],"parameters":[{"name":"NavigationParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ActionIcon","in":"query","schema":{"type":"string"}},{"name":"ActionList","in":"query","schema":{"type":"string"}},{"name":"ActionName","in":"query","schema":{"type":"string"}},{"name":"ActionNameShort","in":"query","schema":{"type":"string"}},{"name":"ActionType","in":"query","schema":{"type":"string"}},{"name":"ActionUrl","in":"query","schema":{"type":"string"}},{"name":"AuthorityType","in":"query","schema":{"type":"string"}},{"name":"AuthorizationRequirement","in":"query","schema":{"type":"string"}},{"name":"ControllerPath","in":"query","schema":{"type":"string"}},{"name":"ExtraBreadcrumb","in":"query","schema":{"type":"string"}},{"name":"HelpUrl","in":"query","schema":{"type":"string"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int32"}},"text/json":{"schema":{"type":"integer","format":"int32"}}}}}}}}}
```

## GET /api/setup/actions

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ActionModel":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"navigationParentActionId":{"type":"string","format":"uuid","nullable":true},"permissionParentActionUrl":{"type":"string","nullable":true},"actionIcon":{"type":"string","nullable":true},"actionList":{"type":"string","nullable":true},"actionName":{"type":"string","nullable":true},"actionNameShort":{"type":"string","nullable":true},"actionType":{"type":"string","nullable":true},"actionUrl":{"type":"string","nullable":true},"authorityType":{"type":"string","nullable":true},"authorizationRequirement":{"type":"string","nullable":true},"controllerPath":{"type":"string","nullable":true},"extraBreadcrumb":{"type":"string","nullable":true},"helpUrl":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/setup/actions":{"get":{"tags":["Setup API: Routes"],"parameters":[{"name":"NavigationParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ActionIcon","in":"query","schema":{"type":"string"}},{"name":"ActionList","in":"query","schema":{"type":"string"}},{"name":"ActionName","in":"query","schema":{"type":"string"}},{"name":"ActionNameShort","in":"query","schema":{"type":"string"}},{"name":"ActionType","in":"query","schema":{"type":"string"}},{"name":"ActionUrl","in":"query","schema":{"type":"string"}},{"name":"AuthorityType","in":"query","schema":{"type":"string"}},{"name":"AuthorizationRequirement","in":"query","schema":{"type":"string"}},{"name":"ControllerPath","in":"query","schema":{"type":"string"}},{"name":"ExtraBreadcrumb","in":"query","schema":{"type":"string"}},{"name":"HelpUrl","in":"query","schema":{"type":"string"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionModel"}}}}}}}}}}
```

## POST /api/setup/actions

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CreateAction":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"navigationParentActionId":{"type":"string","format":"uuid","nullable":true},"permissionParentActionId":{"type":"string","format":"uuid","nullable":true},"actionIcon":{"type":"string","nullable":true},"actionList":{"type":"string","nullable":true},"actionName":{"type":"string","nullable":true},"actionNameShort":{"type":"string","nullable":true},"actionType":{"type":"string","nullable":true},"actionUrl":{"type":"string","nullable":true},"authorityType":{"type":"string","nullable":true},"authorizationRequirement":{"type":"string","nullable":true},"controllerPath":{"type":"string","nullable":true},"extraBreadcrumb":{"type":"string","nullable":true},"helpUrl":{"type":"string","nullable":true}},"additionalProperties":false},"ActionModel":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"navigationParentActionId":{"type":"string","format":"uuid","nullable":true},"permissionParentActionUrl":{"type":"string","nullable":true},"actionIcon":{"type":"string","nullable":true},"actionList":{"type":"string","nullable":true},"actionName":{"type":"string","nullable":true},"actionNameShort":{"type":"string","nullable":true},"actionType":{"type":"string","nullable":true},"actionUrl":{"type":"string","nullable":true},"authorityType":{"type":"string","nullable":true},"authorizationRequirement":{"type":"string","nullable":true},"controllerPath":{"type":"string","nullable":true},"extraBreadcrumb":{"type":"string","nullable":true},"helpUrl":{"type":"string","nullable":true}},"additionalProperties":false},"ValidationFailure":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"extensions":{"type":"object","additionalProperties":{"nullable":true},"nullable":true}},"additionalProperties":false}}},"paths":{"/api/setup/actions":{"post":{"tags":["Setup API: Routes"],"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateAction"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateAction"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateAction"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateAction"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailure"}}}}}}}}}
```

## GET /api/setup/actions/search

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ActionMatch":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/api/setup/actions/search":{"get":{"tags":["Setup API: Routes"],"parameters":[{"name":"NavigationParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"PermissionParentActionId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"ActionIcon","in":"query","schema":{"type":"string"}},{"name":"ActionList","in":"query","schema":{"type":"string"}},{"name":"ActionName","in":"query","schema":{"type":"string"}},{"name":"ActionNameShort","in":"query","schema":{"type":"string"}},{"name":"ActionType","in":"query","schema":{"type":"string"}},{"name":"ActionUrl","in":"query","schema":{"type":"string"}},{"name":"AuthorityType","in":"query","schema":{"type":"string"}},{"name":"AuthorizationRequirement","in":"query","schema":{"type":"string"}},{"name":"ControllerPath","in":"query","schema":{"type":"string"}},{"name":"ExtraBreadcrumb","in":"query","schema":{"type":"string"}},{"name":"HelpUrl","in":"query","schema":{"type":"string"}},{"name":"Identifier","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.When","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"Origin.Organization","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.User","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Proxy","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"Origin.Description","in":"query","schema":{"type":"string"}},{"name":"Origin.Reason","in":"query","schema":{"type":"string"}},{"name":"Origin.Source","in":"query","schema":{"type":"string"}},{"name":"Filter.Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.PageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Filter.Sort","in":"query","schema":{"type":"string"}},{"name":"Filter.Excludes","in":"query","schema":{"type":"string"}},{"name":"Filter.Includes","in":"query","schema":{"type":"string"}},{"name":"Filter.Format","in":"query","schema":{"type":"string"}},{"name":"Texts","in":"query","schema":{"type":"object","additionalProperties":{"type":"string","nullable":true}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionMatch"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionMatch"}}}}}}}}}}
```

## GET /api/setup/routes/settings

>

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"paths":{"/api/setup/routes/settings":{"get":{"tags":["Setup API: Routes"],"parameters":[{"name":"url","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSettings"}},"text/json":{"schema":{"$ref":"#/components/schemas/PageSettings"}}}}}}}},"components":{"schemas":{"PageSettings":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid"},"pageId":{"type":"string","format":"uuid","nullable":true},"coreAbout":{"$ref":"#/components/schemas/AboutModel"},"customAbout":{"$ref":"#/components/schemas/AboutModel"},"breadcrumbs":{"type":"array","items":{"$ref":"#/components/schemas/BreadcrumbModel"},"nullable":true},"displayCalendar":{"type":"boolean"},"actionTitle":{"type":"string","nullable":true},"fullWidth":{"type":"boolean"},"problems":{"type":"array","items":{"$ref":"#/components/schemas/Problem"},"nullable":true},"download":{"$ref":"#/components/schemas/DownloadSettings"}},"additionalProperties":false},"AboutModel":{"type":"object","properties":{"heading":{"type":"string","nullable":true},"body":{"type":"string","nullable":true}},"additionalProperties":false},"BreadcrumbModel":{"type":"object","properties":{"text":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false},"Problem":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"extensions":{"type":"object","additionalProperties":{"nullable":true},"nullable":true}},"additionalProperties":false},"DownloadSettings":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/DownloadColumnSettings"},"nullable":true}},"additionalProperties":false},"DownloadColumnSettings":{"type":"object","properties":{"physicalName":{"type":"string","nullable":true},"logicalHeading":{"type":"string","nullable":true},"hideByDefault":{"type":"boolean"}},"additionalProperties":false}}}}
```