Create a data point value
post
/fscmRestApi/resources/11.13.18.05/dataPointValues
Request
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:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountNumber: string
Title:
Account Number
Maximum Length:30
The unique number that identifies the account that the data point value is mapped to. -
CurrencyCode: string
Maximum Length:
15
Code that indicates the currency that a data point value is mapped to. -
DataPointId: integer
(int64)
The unique identifier of the credit and collections data point that the data point value is mapped to.
-
DataPointRepositoryId: integer
(int64)
The unique identifier of the data point value.
-
DataPointValue: string
The value of the data point.
-
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique number that identifies the party that the data point value is mapped to. -
UpdateCaseFolder: string
Indicates whether the data point value should be updated in case folders.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : dataPointValues-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Account Number
Maximum Length:30
The unique number that identifies the account that the data point value is mapped to. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the data point value. -
CreationDate: string
(date-time)
Read Only:
true
The date when the data point value was created. -
CreationMechanism: string
Read Only:
true
Maximum Length:30
The mechanism used to create the data point value in the repository. -
CurrencyCode: string
Maximum Length:
15
Code that indicates the currency that a data point value is mapped to. -
DataPointId: integer
(int64)
The unique identifier of the credit and collections data point that the data point value is mapped to.
-
DataPointName: string
Read Only:
true
Maximum Length:80
The name of the credit and collections data point that the data point value is mapped to. -
DataPointRepositoryId: integer
(int64)
The unique identifier of the data point value.
-
DataPointValue: string
The value of the data point.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the data point value was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the data point value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party that the data point value is mapped to. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique number that identifies the party that the data point value is mapped to. -
UpdateCaseFolder: string
Indicates whether the data point value should be updated in case folders.
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.