Data Transfer Objects (DTOs)
EntDevDTO
Arguments/Elements | Type | Format | Description | Required | Notes |
---|---|---|---|---|---|
Meridium.Api.CustDev.Core.EntDevDTO | object | N/A | Entity DTO | Required | None |
Key | Integer/Long | Int64 | Entity Key | Optional | Must be zero for insert, non-zero for update and cannot be changed. |
id | String | N/A | Entity ID | Optional | Read only, computed value |
seqNum | Integer/Long | Int64 | Sequence Number | Optional | Required for insert and update. Enables consistency and concurrency for database transactions |
familyKey | Integer/Long | Int64 | Family Key of the entity | Optional | Required for insert and update. |
familyId | String | N/A | Family Id of the entity | Optional | Nullable: true Not required for insert and update |
updateDate | String | Date-time | Date and time of last update | Optional | Read only. This value will be in the local time zone of the session user |
fields | Array | N/A | Family Fields | Optional | Only those field whose values are to be changed are required. |
FldDevDTO
Arguments/Elements | Type | Format | Description | Required | Notes | |
---|---|---|---|---|---|---|
Meridium.Api.CustDev.Core.EntDevDTO | object | N/A | Entity field | Required | When creating or updating a field using FldDevDTO, either Key or Id are required but both. | |
Key | Integer | int64 | Metadata field key. | Optional | Either Id or Key are required for insert and update | |
id | String | N/A | Metadata field key. | Optional | Either Id or Key are required for insert and update | |
value | Object | Date-time | Field value | Optional | Required for insert and update. |
FmlyDevDTO
Arguments/Elements | Type | Format | Description | Required | Notes |
---|---|---|---|---|---|
Meridium.Api.CustDev.Core.FmlyFLDDevDTO | Object | N/A | Metadata family field | Required | None |
key | Integer | int64 | Metadata family field | Optional | None |
id | String | N/A | Metadata family field | Optional | None |
FmlyFLDDevDTO
Arguments/Elements | Type | Format | Description | Required | Notes |
---|---|---|---|---|---|
Meridium.Api.CustDev.Core.FmlyFLDDevDTO | Object | N/A | Metadata family field. | Required | None |
key | Integer | int64 | Metadata family field. | Optional | None |
id | String | N/A | Metadata family field. | Optional | None |
RelDevDTO
Arguments/Elements | Type | Format | Description | Required | Notes |
---|---|---|---|---|---|
Meridium.Api.CustDev.Core.RelDevDTO | Object | N/A | Relationship DTO | Required | A relationship is uniquely identified by FamilyKey, PredEntityKey and SuccEntity key. |
Key | Integer/Long | Int64 | Relationship key | Optional | Read only, included for legacy purposes only. |
familyKey | Integer/Long | Int64 | Metadata family key of the relationship | Optional | Required for insert. |
familyID | String | N/A | Metadata family Id | Optional | Nullable: true Not required for insert. |
PredFmlyKey | Integer/Long | Int64 | Predecessor entity family key | Optional | Required for insert |
PredEntityKey | Integer/Long | Int64 | Predecessor entity key | Optional | Required for insert |
SuccFmlyKey | Integer/Long | Int64 | Successor entity family key | Optional | Required for insert |
SuccEntityKey | Integer/Long | Int64 | Successor entity key | Optional | Required for insert |
updateDate | String | Date-time | Date and time of last update | Optional | Read only. This value will be in the local time zone of the session user. |
fields | Array | N/A | Obsolete | Optional | Included for legacy purposes only. There are no relationship families supported by this API which have fields. |