queries

Operations addressed under /queries — 7 operations.

get-query-definition-list

GET

https://dg-sandbox.dgpays.com/core-service

/queries

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<QueryDefinitionDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

get-query-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

code

string

id

string · uuid

name

string

object[]

create-query-definition

POST

https://dg-sandbox.dgpays.com/core-service

/queries

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

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Message
`ERR_CORE_15`	400	NativeQuery with code: `{0}` has already been registered.
`ERR_CORE_16`	400	Native Query Scripts cannot have more than one dbProvider.

create-query-definition › Request Body

code

string · required

name

string · required

object[] · required

create-query-definition › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

get-query-definition-by-code

GET

https://dg-sandbox.dgpays.com/core-service

/queries/by-code/{code}

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 QueryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Message
`ERR_CORE_18`	400	Native Query Code cannot be found.

get-query-definition-by-code › path Parameters

code

string · required

get-query-definition-by-code › 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.

code

string

id

string · uuid

name

string

object[]

delete-query-definition-by-code

DELETE

https://dg-sandbox.dgpays.com/core-service

/queries/by-code/{code}

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	Message
`ERR_CORE_18`	400	Native Query Code cannot be found.

delete-query-definition-by-code › path Parameters

code

string · required

delete-query-definition-by-code › 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

get-query-definition-by-id

GET

https://dg-sandbox.dgpays.com/core-service

/queries/{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 QueryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

get-query-definition-by-id › path Parameters

id

string · uuid · required

get-query-definition-by-id › Responses

code

string

id

string · uuid

name

string

object[]

update-query-definition

PUT

https://dg-sandbox.dgpays.com/core-service

/queries/{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_16`	400	—	Native Query Scripts cannot have more than one dbProvider.
`ERR_CORE_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

update-query-definition › path Parameters

id

string · uuid · required

update-query-definition › Request Body

code

string · required

name

string · required

object[] · required

update-query-definition › Responses

No data returned

delete-query-definition

DELETE

https://dg-sandbox.dgpays.com/core-service

/queries/{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_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

delete-query-definition › path Parameters

id

string · uuid · required

delete-query-definition › Responses

No data returned

proposals services

Core Service

queries

Operations addressed under /queries — 7 operations.

get-query-definition-list

GET

https://dg-sandbox.dgpays.com/core-service

/queries

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<QueryDefinitionDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

get-query-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-query-definition-list › Responses

object[]

Array of catalog-declared response records.

code

string

id

string · uuid

name

string

object[]

create-query-definition

POST

https://dg-sandbox.dgpays.com/core-service

/queries

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

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Message
`ERR_CORE_15`	400	NativeQuery with code: `{0}` has already been registered.
`ERR_CORE_16`	400	Native Query Scripts cannot have more than one dbProvider.

create-query-definition › Request Body

code

string · required

name

string · required

object[] · required

create-query-definition › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

get-query-definition-by-code

GET

https://dg-sandbox.dgpays.com/core-service

/queries/by-code/{code}

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 QueryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Message
`ERR_CORE_18`	400	Native Query Code cannot be found.

get-query-definition-by-code › path Parameters

code

string · required

get-query-definition-by-code › Responses

code

string

id

string · uuid

name

string

object[]

delete-query-definition-by-code

DELETE

https://dg-sandbox.dgpays.com/core-service

/queries/by-code/{code}

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	Message
`ERR_CORE_18`	400	Native Query Code cannot be found.

delete-query-definition-by-code › path Parameters

code

string · required

delete-query-definition-by-code › Responses

No data returned

get-query-definition-by-id

GET

https://dg-sandbox.dgpays.com/core-service

/queries/{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 QueryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`QueryScripts`	`List<QueryScriptDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

get-query-definition-by-id › path Parameters

id

string · uuid · required

get-query-definition-by-id › Responses

code

string

id

string · uuid

name

string

object[]

update-query-definition

PUT

https://dg-sandbox.dgpays.com/core-service

/queries/{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_16`	400	—	Native Query Scripts cannot have more than one dbProvider.
`ERR_CORE_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

update-query-definition › path Parameters

id

string · uuid · required

update-query-definition › Request Body

code

string · required

name

string · required

object[] · required

update-query-definition › Responses

No data returned

delete-query-definition

DELETE

https://dg-sandbox.dgpays.com/core-service

/queries/{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_17`	400	`QUERY_DEFINITION_MUST_BE_NOT_NULL`	Native Query cannot be found.

delete-query-definition › path Parameters

id

string · uuid · required

delete-query-definition › Responses

No data returned

proposals services