Returns a region configuration from the system by its ID.

Request

This method will look up a region configuration by the specified ID and return it back.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/regionConfigurations/{tenantId}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The region configuration was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

default_region_idstring(Default Region)

The default region id to use

namestring(Name)required

The name of the region configuration

notesstring(Notes)

Any notes about this configuration

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring, (date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring, (date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

zonesArray of objects

Response

{
  "default_region_id": "string",
  "name": "string",
  "notes": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1,
  "zones": [
    { … }
  ]
}