Field Default Value

Field Default Value - Get Field Default Value

HTTP Request

GET /api/field-default-values/{id}

Interactive Demo

📋 Description: Fetches the default field values associated with a specific asset in the Nakisa Portfolio Management Suite, facilitating enhanced data analytics and portfolio management for real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	FieldDefaultValueDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "entityType": "string",
  "fieldName": "string",
  "fieldValue": "string",
  "conditionValue": "string",
  "isActive": true,
  "isLocked": true,
  "userId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Field Default Value - Update Field Default Value

HTTP Request

PUT /api/field-default-values/{id}

Interactive Demo

📋 Description: Updates the default values for a specified field within the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant data for portfolio, asset, and real estate property analytics.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	FieldDefaultValueDto	true	Request body containing the updated default field values for a specified asset within the Nakisa Portfolio Management Suite, relevant to portfolio analytics and real estate property management.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "entityType": "string",
  "fieldName": "string",
  "fieldValue": "string",
  "conditionValue": "string",
  "isActive": true,
  "isLocked": true,
  "userId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	FieldDefaultValueDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "entityType": "string",
  "fieldName": "string",
  "fieldValue": "string",
  "conditionValue": "string",
  "isActive": true,
  "isLocked": true,
  "userId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Field Default Value - Delete Field Default Value

HTTP Request

DELETE /api/field-default-values/{id}

Interactive Demo

📋 Description: Deletes a specified field default value from the Nakisa Portfolio Management Suite, streamlining the management of portfolio, asset, and real estate property data.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Field Default Value - Get Field Default Values

HTTP Request

GET /api/field-default-values

Interactive Demo

📋 Description: Retrieves default field values for portfolio assets within the Nakisa Portfolio Management Suite, enabling users to streamline data entry and enhance analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the field default values query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics.
entity-type	query	string	false	Specifies the type of entity for which default field values are being retrieved, applicable to portfolio, asset, analytics, or real estate property contexts.
field-name	query	string	false	Specifies the name of the field for which default values are being retrieved within the Nakisa Portfolio Management Suite, applicable to portfolio, asset, analytics, and real estate property contexts.
field-value	query	string	false	Specifies the value of a particular field to retrieve default settings related to portfolios, assets, analytics, or real estate properties within the Nakisa Portfolio Management Suite.
condition-value	query	string	false	Specifies the condition value to filter and retrieve default values for fields related to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.
entity-type-like	query	string	false	Specifies the type of entity, such as portfolio, asset, analytics, or real estate property, to filter the default values returned by the API.
field-name-like	query	string	false	Specifies a pattern to match field names in the context of portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.
active	query	string	false	Whether this resource is active
locked	query	string	false	Whether this resource is locked
global	query	string	false	Specifies the global context for retrieving default field values related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.
user	query	string	false	Specifies the username associated with the portfolio, asset, or analytics data being retrieved from the Nakisa Portfolio Management Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelFieldDefaultValueDto

Example Responses

{
  "_embedded": {
    "fieldDefaultValues": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "entityType": "string",
        "fieldName": "string",
        "fieldValue": "string",
        "conditionValue": "string",
        "isActive": true,
        "isLocked": true,
        "userId": 0
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Field Default Value - Create Field Default Values

HTTP Request

POST /api/field-default-values

Interactive Demo

📋 Description: Creates default values for specified fields within the Nakisa Portfolio Management Suite, enabling consistent data entry across portfolio, asset, and real estate property analytics.

Parameters

Name	In	Type	Required	Description
body	body	FieldDefaultValueDto	true	Request body containing default values for portfolio assets, including relevant analytics and real estate property attributes.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "entityType": "string",
    "fieldName": "string",
    "fieldValue": "string",
    "conditionValue": "string",
    "isActive": true,
    "isLocked": true,
    "userId": 0
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "entityType": "string",
    "fieldName": "string",
    "fieldValue": "string",
    "conditionValue": "string",
    "isActive": true,
    "isLocked": true,
    "userId": 0
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[FieldDefaultValueDto]	false	none	[Data transfer object representing the default values for fields within the Nakisa Portfolio Management Suite, facilitating consistent data entry and analytics across portfolio, asset, and real estate property management.]
» createdBy	string	false	none	Username of who created this resource
» lastModifiedBy	string	false	none	Username of who last modified this resource
» createdDate	string(date-time)	false	none	Date of the created
» lastModifiedDate	string(date-time)	false	none	Date of the last modified
» archived	boolean	false	none	Boolean flag indicating archived status
» externalId	string	false	none	Unique identifier for the external
» id	integer(int64)	false	none	Unique identifier for the resource
» entityType	string	false	none	Type of the entity
» fieldName	string	false	none	Name of the field
» fieldValue	string	false	none	Represents the default value assigned to a specific field within the Nakisa Portfolio Management Suite, facilitating consistent data entry for portfolio, asset, and real estate property analytics.
» conditionValue	string	false	none	Represents the specific value of a condition used in portfolio and asset analytics within the Nakisa Portfolio Management Suite.
» isActive	boolean	false	none	Whether the resource is active
» isLocked	boolean	false	none	Whether the resource is locked
» userId	integer(int64)	false	none	Unique identifier for the user

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Field Default Value - Get Field Default Values For Entity

HTTP Request

GET /api/field-default-values/entityType/{entityType}

Interactive Demo

📋 Description: Retrieves default field values for a specified entity type within the Nakisa Portfolio Management Suite, facilitating efficient data management across portfolio, asset, analytics, and real estate property contexts.

Parameters

Name	In	Type	Required	Description
entityType	path	string	true	Type of the entity
userId	query	integer(int64)	true	Unique identifier for the user
isCreating	query	boolean	false	Whether the resource is creating

Default Values

Parameter	Default	Type
isCreating	false	query

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

{
  "property1": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "entityType": "string",
    "fieldName": "string",
    "fieldValue": "string",
    "conditionValue": "string",
    "isActive": true,
    "isLocked": true,
    "userId": 0
  },
  "property2": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "entityType": "string",
    "fieldName": "string",
    "fieldValue": "string",
    "conditionValue": "string",
    "isActive": true,
    "isLocked": true,
    "userId": 0
  }
}

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	FieldDefaultValueDto	false	none	Data transfer object representing the default values for fields within the Nakisa Portfolio Management Suite, facilitating consistent data entry and analytics across portfolio, asset, and real estate property management.
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» entityType	string	false	none	Type of the entity
»» fieldName	string	false	none	Name of the field
»» fieldValue	string	false	none	Represents the default value assigned to a specific field within the Nakisa Portfolio Management Suite, facilitating consistent data entry for portfolio, asset, and real estate property analytics.
»» conditionValue	string	false	none	Represents the specific value of a condition used in portfolio and asset analytics within the Nakisa Portfolio Management Suite.
»» isActive	boolean	false	none	Whether the resource is active
»» isLocked	boolean	false	none	Whether the resource is locked
»» userId	integer(int64)	false	none	Unique identifier for the user

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---