Platform: Routes

get

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/platform/actions/{id} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "ActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "NavigationParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ActionCategory": "text",
  "ActionIcon": "text",
  "ActionList": "text",
  "ActionName": "text",
  "ActionNameShort": "text",
  "ActionType": "text",
  "ActionUrl": "text",
  "AuthorizationRequirement": "text",
  "ControllerPath": "text",
  "HelpUrl": "text"
}

put

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

ActionIdentifierstring · uuidOptional

NavigationParentActionIdentifierstring · uuid | nullableOptional

PermissionParentActionIdentifierstring · uuid | nullableOptional

ActionCategorystring | nullableOptional

ActionIconstring | nullableOptional

ActionListstring | nullableOptional

ActionNamestring | nullableOptional

ActionNameShortstring | nullableOptional

ActionTypestring | nullableOptional

ActionUrlstring | nullableOptional

AuthorizationRequirementstring | nullableOptional

ControllerPathstring | nullableOptional

HelpUrlstring | nullableOptional

Responses

200

OK

400

Bad Request

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/e01/platform/actions/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "ActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "NavigationParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ActionCategory": "text",
  "ActionIcon": "text",
  "ActionList": "text",
  "ActionName": "text",
  "ActionNameShort": "text",
  "ActionType": "text",
  "ActionUrl": "text",
  "AuthorizationRequirement": "text",
  "ControllerPath": "text",
  "HelpUrl": "text"
}

application/jsontext/jsonapplication/*+json

No content

delete

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

404

Not Found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v2/e01/platform/actions/{id} HTTP/1.1
Host: 
Accept: */*

No content

head

Path parameters

actionstring · uuidRequired

idstringRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/e01/platform/actions/{id} HTTP/1.1
Host: 
Accept: */*

200

OK

true

get

Query parameters

NavigationParentActionIdentifierstring · uuidOptional

PermissionParentActionIdentifierstring · uuidOptional

ActionCategorystringOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

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.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/platform/actions/count HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "Count": 1
}

get

Query parameters

NavigationParentActionIdentifierstring · uuidOptional

PermissionParentActionIdentifierstring · uuidOptional

ActionCategorystringOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

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.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Pageinteger · int32Optional

Takeinteger · int32Optional

SortstringOptional

ExcludesstringOptional

IncludesstringOptional

FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/platform/actions HTTP/1.1
Host: 
Accept: */*

200

OK

[
  {
    "ActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "NavigationParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "PermissionParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ActionCategory": "text",
    "ActionIcon": "text",
    "ActionList": "text",
    "ActionName": "text",
    "ActionNameShort": "text",
    "ActionType": "text",
    "ActionUrl": "text",
    "AuthorizationRequirement": "text",
    "ControllerPath": "text",
    "HelpUrl": "text"
  }
]

post

Body

application/jsontext/jsonapplication/*+json

ActionIdentifierstring · uuidOptional

NavigationParentActionIdentifierstring · uuid | nullableOptional

PermissionParentActionIdentifierstring · uuid | nullableOptional

ActionCategorystring | nullableOptional

ActionIconstring | nullableOptional

ActionListstring | nullableOptional

ActionNamestring | nullableOptional

ActionNameShortstring | nullableOptional

ActionTypestring | nullableOptional

ActionUrlstring | nullableOptional

AuthorizationRequirementstring | nullableOptional

ControllerPathstring | nullableOptional

HelpUrlstring | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /v2/e01/platform/actions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "ActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "NavigationParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ActionCategory": "text",
  "ActionIcon": "text",
  "ActionList": "text",
  "ActionName": "text",
  "ActionNameShort": "text",
  "ActionType": "text",
  "ActionUrl": "text",
  "AuthorizationRequirement": "text",
  "ControllerPath": "text",
  "HelpUrl": "text"
}

application/jsontext/jsonapplication/*+json

{
  "ActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "NavigationParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PermissionParentActionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ActionCategory": "text",
  "ActionIcon": "text",
  "ActionList": "text",
  "ActionName": "text",
  "ActionNameShort": "text",
  "ActionType": "text",
  "ActionUrl": "text",
  "AuthorizationRequirement": "text",
  "ControllerPath": "text",
  "HelpUrl": "text"
}

get

Query parameters

NavigationParentActionIdentifierstring · uuidOptional

PermissionParentActionIdentifierstring · uuidOptional

ActionCategorystringOptional

ActionIconstringOptional

ActionListstringOptional

ActionNamestringOptional

ActionNameShortstringOptional

ActionTypestringOptional

ActionUrlstringOptional

AuthorizationRequirementstringOptional

ControllerPathstringOptional

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.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Pageinteger · int32Optional

Takeinteger · int32Optional

SortstringOptional

ExcludesstringOptional

IncludesstringOptional

FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/platform/actions/search HTTP/1.1
Host: 
Accept: */*

200

OK

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