services

Operations addressed under /services — 7 operations.

aurax-bff-redirect-get-service-definition-list

GET

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

/services

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

Response body, read from the service source

The route declares its response as IEnumerable<ServiceDefinitionDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Code`	`string`	no
`HasFilter`	`bool`	no
`HasSharedCacheData`	`bool`	no
`HasPaging`	`bool`	no
`DefaultPagingSize`	`int?`	yes
`HasOrder`	`bool`	no
`DefaultOrderField`	`string`	no
`DefaultOrderType`	`int?`	yes
`IsCacheable`	`bool`	no
`CacheDuration`	`int?`	yes
`IsActive`	`bool`	no
`Path`	`string`	no
`DomainId`	`Guid`	no
`OperationType`	`int`	no
`Type`	`int`	no
`UsageType`	`int`	no
`Weight`	`double?`	yes
`BusinessWeight`	`double?`	yes
`HasBpmVariable`	`bool`	no
`ResponseFieldDefinitionId`	`Guid?`	yes
`RequestFieldId`	`Guid?`	yes
`IsTransactional`	`bool?`	yes
`IsRedirect`	`bool?`	yes
`RoutingServiceDefinitionId`	`Guid?`	yes
`FraudServiceDefinitionId`	`Guid?`	yes
`TimeoutDuration`	`long?`	yes
`IsLogDetailEnabled`	`bool`	no
`HasTranslationData`	`bool?`	yes
`RollbackServiceDefinitionId`	`Guid?`	yes
`RollbackEventDefinitionId`	`Guid?`	yes
`KeywordIdList`	`IEnumerable<Guid>` (collection)	no
`Translations`	`IEnumerable<ServiceDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

aurax-bff-redirect-get-service-definition-list › 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

aurax-bff-redirect-create-service-definition

POST

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

/services

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

aurax-bff-redirect-create-service-definition › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

aurax-bff-redirect-get-service-detail-by-code

GET

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

/services/by-code/{code}/details

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

aurax-bff-redirect-get-service-detail-by-code › path Parameters

code

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-service-detail-by-code › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

get-service-by-id

GET

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

/services/{id}

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

Response body, read from the service source

The route declares its response as ServiceDetailDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Code`	`string`	no
`HasFilter`	`bool`	no
`HasSharedCacheData`	`bool`	no
`HasPaging`	`bool`	no
`DefaultPagingSize`	`int?`	yes
`HasOrder`	`bool`	no
`DefaultOrderField`	`string`	no
`DefaultOrderType`	`int?`	yes
`IsCacheable`	`bool`	no
`CacheDuration`	`int?`	yes
`IsActive`	`bool`	no
`Path`	`string`	no
`DomainId`	`Guid`	no
`OperationType`	`int`	no
`Type`	`int`	no
`UsageType`	`int`	no
`Weight`	`double?`	yes
`BusinessWeight`	`double?`	yes
`HasBpmVariable`	`bool`	no
`ResponseFieldDefinitionId`	`Guid?`	yes
`RequestFieldId`	`Guid?`	yes
`IsTransactional`	`bool?`	yes
`RoutingServiceDefinitionId`	`Guid?`	yes
`FraudServiceDefinitionId`	`Guid?`	yes
`IsRedirect`	`bool?`	yes
`TimeoutDuration`	`long?`	yes
`IsLogDetailEnabled`	`bool`	no
`HasTranslationData`	`bool?`	yes
`RollbackServiceDefinitionId`	`Guid?`	yes
`RollbackEventDefinitionId`	`Guid?`	yes
`KeywordIdList`	`IEnumerable<Guid>` (collection)	no
`Translations`	`IEnumerable<ServiceDefinitionTranslationDto>` (collection)	no
`ServiceDefinitionRequestList`	`IEnumerable<ServiceDefinitionRequestListDto>` (collection)	no
`ServiceDefinitionResponseList`	`IEnumerable<ServiceDefinitionResponseListDto>` (collection)	no
`ServiceDefinitionRefreshCacheMapList`	`IEnumerable<ServiceDefinitionRefreshCacheMapDto>` (collection)	no
`Validations`	`IEnumerable<ServiceDefinitionValidationDto>` (collection)	no

Member names are the service's declaration names.

get-service-by-id › path Parameters

id

string · uuid · required

get-service-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.

businessWeight

number

cacheDuration

integer · int32

code

defaultOrderField

string

defaultOrderType

integer · int32

defaultPagingSize

integer · int32

domainId

string · uuid

hasBpmVariable

boolean

hasFilter

boolean

hasOrder

boolean

hasPaging

boolean

hasSharedCacheData

boolean

hasTranslationData

boolean

id

isActive

boolean

isCacheable

boolean

isLogDetailEnabled

boolean

isTransactional

boolean

keywordIdList

string[]

name

operationType

integer · int32

path

string

requestFieldId

string · uuid

responseFieldId

string · uuid

rollbackEventDefinitionId

string · uuid

rollbackServiceDefinitionId

string · uuid

routingServiceDefinitionId

string · uuid

object[]

timeoutDuration

integer · int64

object[]

type

usageType

integer · int32

object[]

weight

number

GET/services/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/services/:id

Example Responses

{
  "businessWeight": 0,
  "cacheDuration": 0,
  "code": {},
  "defaultOrderField": "defaultOrderField",
  "defaultOrderType": 0,
  "defaultPagingSize": 0,
  "domainId": "00000000-0000-0000-0000-000000000000",
  "hasBpmVariable": true,
  "hasFilter": true,
  "hasOrder": true,
  "hasPaging": true,
  "hasSharedCacheData": true,
  "hasTranslationData": true,
  "id": {},
  "isActive": true,
  "isCacheable": true,
  "isLogDetailEnabled": true,
  "isTransactional": true,
  "keywordIdList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "name": {},
  "operationType": 0,
  "path": "path",
  "requestFieldId": "00000000-0000-0000-0000-000000000000",
  "responseFieldId": "00000000-0000-0000-0000-000000000000",
  "rollbackEventDefinitionId": "00000000-0000-0000-0000-000000000000",
  "rollbackServiceDefinitionId": "00000000-0000-0000-0000-000000000000",
  "routingServiceDefinitionId": "00000000-0000-0000-0000-000000000000",
  "serviceDefinitionRefreshCacheMapList": [
    {}
  ],
  "serviceDefinitionRequestList": [
    {
      "customName": "customName",
      "defaultValue": "defaultValue",
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "location": 0,
      "necessity": 0,
      "necessityFormulaId": "00000000-0000-0000-0000-000000000000",
      "necessityLocalizationCode": "necessityLocalizationCode",
      "parentServiceRequestId": "00000000-0000-0000-0000-000000000000",
      "requestId": {},
      "serviceRequestName": {},
      "transactionalFieldId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "serviceDefinitionResponseList": [
    {
      "fieldId": "00000000-0000-0000-0000-000000000000",
      "maskFormatId": "00000000-0000-0000-0000-000000000000",
      "parentServiceResponseId": "00000000-0000-0000-0000-000000000000",
      "responseId": {},
      "serviceResponseName": {}
    }
  ],
  "timeoutDuration": 0,
  "translations": [
    {
      "languageCode": "languageCode",
      "name": {}
    }
  ],
  "type": {},
  "usageType": 0,
  "validations": [
    {
      "id": {},
      "serviceId": "00000000-0000-0000-0000-000000000000",
      "sortOrder": 0,
      "validationId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "weight": 0
}

json

application/json

aurax-bff-redirect-update-service-definition

PUT

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

/services/{id}

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

aurax-bff-redirect-update-service-definition › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-update-service-definition › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

aurax-bff-redirect-delete-service-definition

DELETE

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

/services/{id}

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

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

aurax-bff-redirect-delete-service-definition › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-delete-service-definition › Responses

No data returned

aurax-bff-redirect-get-service-definition-validation-list

GET

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

/services/{id}/validations

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

Response body, read from the service source

The route declares its response as IEnumerable<ServiceDefinitionValidationDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ServiceId`	`Guid`	no
`ValidationId`	`Guid`	no
`SortOrder`	`int`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

aurax-bff-redirect-get-service-definition-validation-list › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-service-definition-validation-list › Responses

No data returned

service-logs services-bpmn