Create an account extension base
post
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
The user who created the object record. -
CreationDate: string
(date-time)
The date when the record was created.
-
Id: integer
(int64)
The unique identifier of the object record.
-
LastUpdateDate: string
(date-time)
The date when the record was last updated.
-
LastUpdatedBy: string
Maximum Length:
64
The user who last updated the record. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParentId: integer
(int64)
The identifier for the foreign key to parent.
-
RecordName: string
Title:
Record Name
Maximum Length:80
The name of the object record. -
RecordNumber: string
Title:
Record Number
Maximum Length:64
The unique identifier of the object record. -
RowType: string
Maximum Length:
30
The identifier of the custom extension object row.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : accounts-AccountExtensionBase-item-response
Type:
Show Source
object
-
CreatedBy: string
Maximum Length:
64
The user who created the object record. -
CreationDate: string
(date-time)
The date when the record was created.
-
Id: integer
(int64)
The unique identifier of the object record.
-
LastUpdateDate: string
(date-time)
The date when the record was last updated.
-
LastUpdatedBy: string
Maximum Length:
64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParentId: integer
(int64)
The identifier for the foreign key to parent.
-
RecordName: string
Title:
Record Name
Maximum Length:80
The name of the object record. -
RecordNumber: string
Title:
Record Number
Maximum Length:64
The unique identifier of the object record. -
RowType: string
Maximum Length:
30
The identifier of the custom extension object row. -
Subtype: string
Read Only:
true
Maximum Length:30
The extension choice list value mapped to the extension child object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.