Get an extended model detail

curl --request GET \
  --url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id} \
  --header 'Authorization: <api-key>'

{
  "ID": 1,
  "ModelName": "User",
  "LastUpdatedBy": "John Smith - [email protected]",
  "UpdatedAt": "2023-06-25 13:37",
  "CustomAttributes": [
    {
      "Name": "Terms of use",
      "Identifier": "terms-of-use",
      "Description": "I have read and agreed with...",
      "Behaviour": 3,
      "DropdownValues": "Fleet_management,Cities,EV_management",
      "ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
      "AddToKeyMetadata": true,
      "Required": true,
      "ShowOnSignUp": true,
      "WriteOnceReadMany": true,
      "ID": 1,
      "Type": 2
    }
  ],
  "DefaultAttributes": [
    {
      "AddToKeyMetadata": true,
      "ID": 1,
      "Label": "First Name"
    }
  ]
}

GET

extended_attributes

{extended_attribute_id}

Get an extended model detail

curl --request GET \
  --url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id} \
  --header 'Authorization: <api-key>'

{
  "ID": 1,
  "ModelName": "User",
  "LastUpdatedBy": "John Smith - [email protected]",
  "UpdatedAt": "2023-06-25 13:37",
  "CustomAttributes": [
    {
      "Name": "Terms of use",
      "Identifier": "terms-of-use",
      "Description": "I have read and agreed with...",
      "Behaviour": 3,
      "DropdownValues": "Fleet_management,Cities,EV_management",
      "ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
      "AddToKeyMetadata": true,
      "Required": true,
      "ShowOnSignUp": true,
      "WriteOnceReadMany": true,
      "ID": 1,
      "Type": 2
    }
  ],
  "DefaultAttributes": [
    {
      "AddToKeyMetadata": true,
      "ID": 1,
      "Label": "First Name"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

extended_attribute_id

integer

required

UID of extended attribute

Example:

1

Response

integer

UID of this extended attribute

Example:

1

ModelName

string

Name of the model for which the custom attributes are extended

Example:

"User"

LastUpdatedBy

string

User that made the last update of one of the custom attributes for the extended model

Example:

"John Smith - [email protected]"

UpdatedAt

string

Timestamp of the last update

Example:

"2023-06-25 13:37"

CustomAttributes

object[]

custom attributes extended for this model

Show child attributes

CustomAttributes.Name

string

Label for custom attribute

Example:

"Terms of use"

CustomAttributes.Identifier

string

Unique string identifier for custom attribute

Example:

"terms-of-use"

CustomAttributes.Description

string

Description for custom attribute

Example:

"I have read and agreed with..."

CustomAttributes.Behaviour

enum<integer>

custom attribute behaviour: 1 -> Developers can view and edit the attribute, 2 -> Developers can only view the attribute, 3 -> Developers cannot see the attribute

Available options:

1,

2,

3

Example:

3

Values to display in dropdown options if the attribute type is 2

Example:

"Fleet_management,Cities,EV_management"

CustomAttributes.ValidationRegExp

string

Validation to be applied for string type attributes (type 1)

Example:

"www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+"

CustomAttributes.AddToKeyMetadata

boolean

Defines if the value of this custom attribute should be injected into the credential's metadata

Example:

true

CustomAttributes.Required

boolean

Defines if the value of this custom attribute is required to create a new object

Example:

true

Defines if this custom attribute should be displayed in the sign up form

Example:

true

CustomAttributes.WriteOnceReadMany

boolean

If set to true the value is set only once for the first time

Example:

true

CustomAttributes.ID

integer

UID of this custom attribute

Example:

1

CustomAttributes.Type

enum<integer>

custom attribute type: 1 -> String, 2 -> Dropdown, 3 -> Boolean, 4 -> Number

Available options:

1,

2,

3,

4

Example:

2

DefaultAttributes

object[]

default attributes included for this model

Show child attributes

DefaultAttributes.AddToKeyMetadata

boolean

If set to true the value for this default attribute will be injected in the credential metadata

Example:

true

DefaultAttributes.ID

integer

UID of this default attribute

Example:

1

DefaultAttributes.Label

string

Name of default attribute field

Example:

"First Name"

List all extended models List all custom attributes for a particular extended model

⌘I

Overview

Getting Started

Publishing APIs

Consuming APIs

User Management

Portal Administration

Reference

Legacy Products

Get an extended model detail

Authorizations

Path Parameters

Response