Setup API: Routes

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

application/jsontext/json

actionIdstring · uuidOptional

navigationParentActionIdstring · uuid · nullableOptional

permissionParentActionUrlstring · nullableOptional

actionIconstring · nullableOptional

actionListstring · nullableOptional

actionNamestring · nullableOptional

actionNameShortstring · nullableOptional

actionTypestring · nullableOptional

actionUrlstring · nullableOptional

authorityTypestring · nullableOptional

authorizationRequirementstring · nullableOptional

controllerPathstring · nullableOptional

extraBreadcrumbstring · nullableOptional

helpUrlstring · nullableOptional

get

/api/setup/actions/{id}

HTTPcURLJavaScriptPython

GET /v2/e01/api/setup/actions/{id} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "actionId": "123e4567-e89b-12d3-a456-426614174000",
  "navigationParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionParentActionUrl": "text",
  "actionIcon": "text",
  "actionList": "text",
  "actionName": "text",
  "actionNameShort": "text",
  "actionType": "text",
  "actionUrl": "text",
  "authorityType": "text",
  "authorizationRequirement": "text",
  "controllerPath": "text",
  "extraBreadcrumb": "text",
  "helpUrl": "text"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

idstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

actionIdstring · uuidOptional

navigationParentActionIdstring · uuid · nullableOptional

permissionParentActionIdstring · uuid · nullableOptional

actionIconstring · nullableOptional

actionListstring · nullableOptional

actionNamestring · nullableOptional

actionNameShortstring · nullableOptional

actionTypestring · nullableOptional

actionUrlstring · nullableOptional

authorityTypestring · nullableOptional

authorizationRequirementstring · nullableOptional

controllerPathstring · nullableOptional

extraBreadcrumbstring · nullableOptional

helpUrlstring · nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/api/setup/actions/{id}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/setup/actions/{id} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 430

{
  "actionId": "123e4567-e89b-12d3-a456-426614174000",
  "navigationParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "actionIcon": "text",
  "actionList": "text",
  "actionName": "text",
  "actionNameShort": "text",
  "actionType": "text",
  "actionUrl": "text",
  "authorityType": "text",
  "authorizationRequirement": "text",
  "controllerPath": "text",
  "extraBreadcrumb": "text",
  "helpUrl": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

No content

404

Not Found

delete

/api/setup/actions/{id}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/setup/actions/{id} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/setup/actions/{id}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/setup/actions/{id} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

NavigationParentActionIdstring · uuidOptional

PermissionParentActionIdstring · uuidOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorityTypestringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

ExtraBreadcrumbstringOptional

HelpUrlstringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

integer · int32Optional

get

/api/setup/actions/count

HTTPcURLJavaScriptPython

GET /v2/e01/api/setup/actions/count HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

NavigationParentActionIdstring · uuidOptional

PermissionParentActionIdstring · uuidOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorityTypestringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

ExtraBreadcrumbstringOptional

HelpUrlstringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

actionIdstring · uuidOptional

navigationParentActionIdstring · uuid · nullableOptional

permissionParentActionUrlstring · nullableOptional

actionIconstring · nullableOptional

actionListstring · nullableOptional

actionNamestring · nullableOptional

actionNameShortstring · nullableOptional

actionTypestring · nullableOptional

actionUrlstring · nullableOptional

authorityTypestring · nullableOptional

authorizationRequirementstring · nullableOptional

controllerPathstring · nullableOptional

extraBreadcrumbstring · nullableOptional

helpUrlstring · nullableOptional

get

/api/setup/actions

HTTPcURLJavaScriptPython

GET /v2/e01/api/setup/actions HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "actionId": "123e4567-e89b-12d3-a456-426614174000",
    "navigationParentActionId": "123e4567-e89b-12d3-a456-426614174000",
    "permissionParentActionUrl": "text",
    "actionIcon": "text",
    "actionList": "text",
    "actionName": "text",
    "actionNameShort": "text",
    "actionType": "text",
    "actionUrl": "text",
    "authorityType": "text",
    "authorizationRequirement": "text",
    "controllerPath": "text",
    "extraBreadcrumb": "text",
    "helpUrl": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

actionIdstring · uuidOptional

navigationParentActionIdstring · uuid · nullableOptional

permissionParentActionIdstring · uuid · nullableOptional

actionIconstring · nullableOptional

actionListstring · nullableOptional

actionNamestring · nullableOptional

actionNameShortstring · nullableOptional

actionTypestring · nullableOptional

actionUrlstring · nullableOptional

authorityTypestring · nullableOptional

authorizationRequirementstring · nullableOptional

controllerPathstring · nullableOptional

extraBreadcrumbstring · nullableOptional

helpUrlstring · nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/api/setup/actions

HTTPcURLJavaScriptPython

POST /v2/e01/api/setup/actions HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 430

{
  "actionId": "123e4567-e89b-12d3-a456-426614174000",
  "navigationParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "actionIcon": "text",
  "actionList": "text",
  "actionName": "text",
  "actionNameShort": "text",
  "actionType": "text",
  "actionUrl": "text",
  "authorityType": "text",
  "authorizationRequirement": "text",
  "controllerPath": "text",
  "extraBreadcrumb": "text",
  "helpUrl": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "actionId": "123e4567-e89b-12d3-a456-426614174000",
  "navigationParentActionId": "123e4567-e89b-12d3-a456-426614174000",
  "permissionParentActionUrl": "text",
  "actionIcon": "text",
  "actionList": "text",
  "actionName": "text",
  "actionNameShort": "text",
  "actionType": "text",
  "actionUrl": "text",
  "authorityType": "text",
  "authorizationRequirement": "text",
  "controllerPath": "text",
  "extraBreadcrumb": "text",
  "helpUrl": "text"
}

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

NavigationParentActionIdstring · uuidOptional

PermissionParentActionIdstring · uuidOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorityTypestringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

ExtraBreadcrumbstringOptional

HelpUrlstringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

actionIdstring · uuidOptional

get

/api/setup/actions/search

HTTPcURLJavaScriptPython

GET /v2/e01/api/setup/actions/search HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "actionId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Query parameters

urlstringOptional

Responses

200

OK

application/jsontext/json

actionIdstring · uuidOptional

pageIdstring · uuid · nullableOptional

displayCalendarbooleanOptional

actionTitlestring · nullableOptional

fullWidthbooleanOptional

get

/api/setup/routes/settings

HTTPcURLJavaScriptPython

GET /v2/e01/api/setup/routes/settings HTTP/1.1
Accept: */*

200

OK

{
  "actionId": "123e4567-e89b-12d3-a456-426614174000",
  "pageId": "123e4567-e89b-12d3-a456-426614174000",
  "coreAbout": {
    "heading": "text",
    "body": "text"
  },
  "customAbout": {
    "heading": "text",
    "body": "text"
  },
  "breadcrumbs": [
    {
      "text": "text",
      "url": "text"
    }
  ],
  "displayCalendar": true,
  "actionTitle": "text",
  "fullWidth": true,
  "problems": [
    {
      "type": "text",
      "title": "text",
      "status": 1,
      "detail": "text",
      "instance": "text",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": null
      }
    }
  ],
  "download": {
    "columns": [
      {
        "physicalName": "text",
        "logicalHeading": "text",
        "hideByDefault": true
      }
    ]
  }
}