API docs by Redocly

Transaction Schema - DRAFT (0.1.0)

Download OpenAPI specification:Download

E-mail: info@dina-project.net License: Apache 2.0

Transaction API Schema

Transaction

List transactions

List all transactions

query Parameters
sort
string

optional sort order string, such as descending, denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/vnd.api+json
[
  • {
    }
]

Add a Transaction

Add a Transaction

Request Body schema: application/vnd.api+json

Transaction to add

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get a Transaction

Return a single Transaction

path Parameters
Id
required
string <uuid>

ID of Transaction to return

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Transaction

Update a Transaction

path Parameters
Id
required
string <uuid>

Transaction id to patch

Request Body schema: application/vnd.api+json

Transaction to add

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Transaction

Delete a Transaction

path Parameters
Id
required
string <uuid>

Transaction id to delete

Responses

Managed Attribute

List managed attributes

By passing in query string, user can get available managed attributes authorised

query Parameters
filter[rsql]
string

pass an optional search string for looking up the managed attributes

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a managed attribute

Add a managed attribute

Request Body schema: application/json

Managed attribute to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Get a managed attribute

Return a single managed attribute

path Parameters
Id
required
string <uuid>

ID of managed attribute to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a managed attribute

Update a managed attribute

path Parameters
Id
required
string <uuid>

managed attribute id to patch

Request Body schema: application/json

managed attribute to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Delete a managed attribute

Delete a managed attribute

path Parameters
Id
required
string <uuid>

managed attribute id to delete

Responses