Responses

All weza.io entity resources have a few common fields that will appear in all API responses.

We will be leaving out these fields in the REST references descriptions to avoid repetition but keep in mind that they exist. Also note that list API operations responses have a different structure as described in the Pagination section. The fields are described below.

JSON representation
JSON representation
{
"name": string,
"uid": string,
"createdAt": string,
}

Fields

Field

Data Type

Description

name

string

The full resource name.

This field is only used in responses and will be ignored in any request body.

Example: projects/test-project/apps/testapp/borrowers/10023

Read-only

uid

string (uuid)

The unique identifier for any weza.io entity resource constructed from the full resource name. It is in the form of a uuid version 4 string.

You can use a uid interchangeably alongside any other entity resource ID to perform get, patch or delete operations on an entity resource.

For example, if the uid of the resource, projects/test-project/apps/testapp is 1e30f557-c458-4f33-9dee-6271ced2ce7f, then an alias of the resource is projects/test-project/apps/1e30f557-c458-4f33-9dee-6271ced2ce7f.

This field is only used in responses and will be ignored in any request body.

Example: 1e30f557-c458-4f33-9dee-6271ced2ce7f

Read-only

createdAt

string

Resource creation date in ISO format.

This field is only used in responses and will be ignored in any request body.

Example: 2020-03-09T09:27:18.042Z

Read-only