invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomAttributeById: Bouw7 Custom Attribute by ID

read only REST

  • Catalog: Bouw7
  • Schema: Organization
  • Label: Custom Attribute by ID

Returns a single custom attribute based on the given ID. Returns a single custom attribute based on the given ID.

Can only retrieve data.

Summary

Returns a single custom attribute based on the given ID.

API Source

  • Endpoint: /organization/custom-attribute/{id}
  • Operation: get /organization/custom-attribute/{id}

Performance Characteristics

Characteristic Value
Average access latency (ms) 90
Full scan rows per minute 241,000
Point query rows per minute 666

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
id ``

Table Columns

The columns of the table CustomAttributeById are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
createdAt datetime Created at filters on the platform, writable, createdAt The creation time of the entity.
createdBy varchar2 Created by filters on the platform, writable, createdBy The user that created the entity.
fieldType varchar2 Field Type filters on the platform, writable, fieldType The I18N key of the field type.
fieldTypeId int64 Field Type ID filters on the platform, writable, fieldTypeId The ID of the field type.
id int64 ID filters on the platform, writable, id The ID of the custom attribute.
isDisplayedOnCheckoutDocument char Is Displayed on Checkout Document filters on the platform, writable, isDisplayedOnCheckoutDocument Whether the custom attribute is displayed on a checkout document.
isDisplayedOnCompletion char Is Displayed on Completion filters on the platform, writable, isDisplayedOnCompletion Whether the custom attribute is displayed on a completion document.
isDisplayedOnContract char Is Displayed on Contract filters on the platform, writable, isDisplayedOnContract Whether the custom attribute is visible on a contract.
isDisplayedOnDelivery char Is Displayed on Delivery filters on the platform, writable, isDisplayedOnDelivery Whether the custom attribute is displayed on a delivery document.
isDisplayedOnExtraWork char Is Displayed on Extra Work filters on the platform, writable, isDisplayedOnExtraWork Whether the custom attribute is displayed on a extra work document.
isDisplayedOnGarbage char Is Displayed on Garbage filters on the platform, writable, isDisplayedOnGarbage Whether the custom attribute is displayed on a waste document and object.
isDisplayedOnHourRegister char Is Displayed on Hour Register filters on the platform, writable, isDisplayedOnHourRegister Whether the custom attribute is displayed on a hour register document.
isDisplayedOnInvoice char Is Displayed on Invoice filters on the platform, writable, isDisplayedOnInvoice Whether the custom attribute is displayed on an invoice document.
isDisplayedOnMaterial char Is Displayed on Material filters on the platform, writable, isDisplayedOnMaterial Whether the custom attribute is displayed on a material document and object.
isDisplayedOnOutsourcing char Is Displayed on Outsourcing filters on the platform, writable, isDisplayedOnOutsourcing Whether the custom attribute is displayed on a outsourcing document and object.
isDisplayedOnQhse char Is Displayed on QHSE filters on the platform, writable, isDisplayedOnQhse Whether the custom attribute is displayed on a QHSE document.
isReadOnly char Is Read-only filters on the platform, writable, isReadOnly Whether the custom attribute is a read-only field.
isRequired char Is Required filters on the platform, writable, isRequired Whether the custom attribute is a required field.
name varchar2(256) Name filters on the platform, writable, name The name of the custom attribute.
ownerType varchar2 Owner Type filters on the platform, writable, ownerType The I18N key of the owner type, 0 = project, 1 = contact, 3 = employee, 4 = property_asset, 5 = journal_report
ownerTypeId int64 Owner Type ID filters on the platform, writable, ownerTypeId The ID of the owner type.
updatedAt datetime Updated At filters on the platform, writable, updatedAt The last updated time of the entity.
updatedBy varchar2 Updated by filters on the platform, writable, updatedBy The user that last updated the entity.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: