Create a credit and collections data point
post
/fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints
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
-
AmountBased: string
Indicates whether this data point is amount-based.
-
Category: string
The kind of information the data point provides.
-
DataPointId: integer
(int64)
The data point unique identifier.
-
DataType: string
The type of data of the data point value.
-
Description: string
Maximum Length:
400
The data point description. -
Enabled: string
Indicates whether this data point is enabled for use in scoring formulas or is displayed on the UI.
-
Name: string
Maximum Length:
80
The data point name. -
Scorable: string
Indicates whether this data point may be used in scoring models.
-
Source: string
Identifies the source of the data point such as credit, collections, or third-party source.
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 : creditAndCollectionsDataPoints-item-response
Type:
Show Source
object
-
AmountBased: string
Indicates whether this data point is amount-based.
-
Category: string
The kind of information the data point provides.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the data point. -
CreationDate: string
(date-time)
Read Only:
true
The date when the data point was created. -
DataPointId: integer
(int64)
The data point unique identifier.
-
DataType: string
The type of data of the data point value.
-
Description: string
Maximum Length:
400
The data point description. -
Enabled: string
Indicates whether this data point is enabled for use in scoring formulas or is displayed on the UI.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the data point was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the data point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
80
The data point name. -
Scorable: string
Indicates whether this data point may be used in scoring models.
-
Source: string
Identifies the source of the data point such as credit, collections, or third-party source.
-
SystemDerived: string
Read Only:
true
Indicates whether this data point is system derived or automatically calculated by the application.
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.