actions

Operations addressed under /actions — 5 operations.

aurax-management-get-action-definition-list

GET

https://dg-sandbox.dgpays.com/aurax-management-service

/actions

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-get-action-definition-list service definition through GET /actions.

Response body, read from the service source

The route declares its response as IEnumerable<ActionDefinitionDto>.

Field	Declared type	Nullable
`Code`	`string`	no
`IconName`	`string`	no
`SortOrder`	`int?`	yes
`UsageType`	`int`	no
`ActionType`	`int`	no
`ActionProps`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`Translations`	`IEnumerable<ActionDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

aurax-management-get-action-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-management-get-action-definition-list › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

actionProps

string

actionType

integer · int32

code

string

description

string

iconName

string

id

string · uuid

name

string

sortOrder

integer · int32

object[]

usageType

integer · int32

aurax-management-create-action-definition

POST

https://dg-sandbox.dgpays.com/aurax-management-service

/actions

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-create-action-definition service definition through POST /actions.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

aurax-management-create-action-definition › Request Body

actionType

integer · int32 · required

code

string · required

iconName

string · required

sortOrder

integer · int32 · required

object[] · required

usageType

integer · int32 · required

actionProps

string

aurax-management-create-action-definition › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/actions

curl https://dg-sandbox.dgpays.com/aurax-management-service/actions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}'

Example Request Body

{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-management-get-action-definition-by-id

GET

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-get-action-definition-by-id service definition through GET /actions/{id}.

Response body, read from the service source

The route declares its response as ActionDefinitionDto.

Field	Declared type	Nullable
`Code`	`string`	no
`IconName`	`string`	no
`SortOrder`	`int?`	yes
`UsageType`	`int`	no
`ActionType`	`int`	no
`ActionProps`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`Translations`	`IEnumerable<ActionDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`

aurax-management-get-action-definition-by-id › path Parameters

id

string · uuid · required

aurax-management-get-action-definition-by-id › Responses

Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.

actionProps

string

actionType

integer · int32

code

string

description

string

iconName

string

id

string · uuid

name

string

sortOrder

integer · int32

object[]

usageType

integer · int32

aurax-management-update-action-definition

PUT

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-update-action-definition service definition through PUT /actions/{id}.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`

aurax-management-update-action-definition › path Parameters

id

string · uuid · required

aurax-management-update-action-definition › Request Body

actionType

integer · int32 · required

code

string · required

iconName

string · required

sortOrder

integer · int32 · required

object[] · required

usageType

integer · int32 · required

actionProps

string

aurax-management-update-action-definition › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

PUT/actions/{id}

curl https://dg-sandbox.dgpays.com/aurax-management-service/actions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}'

Example Request Body

{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-management-delete-action-definition

DELETE

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-delete-action-definition service definition through DELETE /actions/{id}.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`
`ERR_FRMCTL_24`	400	`ACTION_HAS_FORM_ACTIONS_CANNOT_BE_DELETED`

aurax-management-delete-action-definition › path Parameters

id

string · uuid · required

aurax-management-delete-action-definition › Responses

No data returned

action-groups batch-catalog

Aurax Management

actions

Operations addressed under /actions — 5 operations.

aurax-management-get-action-definition-list

GET

https://dg-sandbox.dgpays.com/aurax-management-service

/actions

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-get-action-definition-list service definition through GET /actions.

Response body, read from the service source

The route declares its response as IEnumerable<ActionDefinitionDto>.

Field	Declared type	Nullable
`Code`	`string`	no
`IconName`	`string`	no
`SortOrder`	`int?`	yes
`UsageType`	`int`	no
`ActionType`	`int`	no
`ActionProps`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`Translations`	`IEnumerable<ActionDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

aurax-management-get-action-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-management-get-action-definition-list › Responses

object[]

Array of catalog-declared response records.

actionProps

string

actionType

integer · int32

code

string

description

string

iconName

string

id

string · uuid

name

string

sortOrder

integer · int32

object[]

usageType

integer · int32

aurax-management-create-action-definition

POST

https://dg-sandbox.dgpays.com/aurax-management-service

/actions

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-create-action-definition service definition through POST /actions.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

aurax-management-create-action-definition › Request Body

actionType

integer · int32 · required

code

string · required

iconName

string · required

sortOrder

integer · int32 · required

object[] · required

usageType

integer · int32 · required

actionProps

string

aurax-management-create-action-definition › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/actions

curl https://dg-sandbox.dgpays.com/aurax-management-service/actions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}'

Example Request Body

{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-management-get-action-definition-by-id

GET

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-get-action-definition-by-id service definition through GET /actions/{id}.

Response body, read from the service source

The route declares its response as ActionDefinitionDto.

Field	Declared type	Nullable
`Code`	`string`	no
`IconName`	`string`	no
`SortOrder`	`int?`	yes
`UsageType`	`int`	no
`ActionType`	`int`	no
`ActionProps`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`Translations`	`IEnumerable<ActionDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`

aurax-management-get-action-definition-by-id › path Parameters

id

string · uuid · required

aurax-management-get-action-definition-by-id › Responses

actionProps

string

actionType

integer · int32

code

string

description

string

iconName

string

id

string · uuid

name

string

sortOrder

integer · int32

object[]

usageType

integer · int32

aurax-management-update-action-definition

PUT

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-update-action-definition service definition through PUT /actions/{id}.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`

aurax-management-update-action-definition › path Parameters

id

string · uuid · required

aurax-management-update-action-definition › Request Body

actionType

integer · int32 · required

code

string · required

iconName

string · required

sortOrder

integer · int32 · required

object[] · required

usageType

integer · int32 · required

actionProps

string

aurax-management-update-action-definition › Responses

No data returned

PUT/actions/{id}

curl https://dg-sandbox.dgpays.com/aurax-management-service/actions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}'

Example Request Body

{
  "actionProps": "",
  "actionType": 0,
  "code": "",
  "iconName": "",
  "sortOrder": 0,
  "translations": [
    {
      "description": "",
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-management-delete-action-definition

DELETE

https://dg-sandbox.dgpays.com/aurax-management-service

/actions/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the aurax-management-delete-action-definition service definition through DELETE /actions/{id}.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRMCTL_12`	400	`ACTION_DEFINITION_ID_NOT_FOUND`
`ERR_FRMCTL_24`	400	`ACTION_HAS_FORM_ACTIONS_CANNOT_BE_DELETED`

aurax-management-delete-action-definition › path Parameters

id

string · uuid · required

aurax-management-delete-action-definition › Responses

No data returned

action-groups batch-catalog