Jump to

• Request
• Response

Update a credit and collections data point

patch

/fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints/{DataPointId}

Request

Path Parameters

• DataPointId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AmountBased: string
  Indicates whether this data point is amount-based.
• Category: string
  The kind of information the data point provides.
• 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.

{
    "type":"object",
    "properties":{
        "AmountBased":{
            "type":"string",
            "description":"Indicates whether this data point is amount-based.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DataPointCode"
                ]
            }
        },
        "Description":{
            "maxLength":"400",
            "type":"string",
            "description":"The data point description.",
            "nullable":true
        },
        "Category":{
            "type":"string",
            "description":"The kind of information the data point provides.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryMeaning"
                ]
            }
        },
        "Scorable":{
            "type":"string",
            "description":"Indicates whether this data point may be used in scoring models.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ScorableMeaning"
                ]
            }
        },
        "DataType":{
            "type":"string",
            "description":"The type of data of the data point value.",
            "nullable":true,
            "x-queryable":false
        },
        "Enabled":{
            "type":"string",
            "description":"Indicates whether this data point is enabled for use in scoring formulas or is displayed on the UI.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EnabledMeaning"
                ]
            }
        },
        "Source":{
            "type":"string",
            "description":"Identifies the source of the data point such as credit, collections, or third-party source.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SourceMeaning"
                ]
            }
        },
        "Name":{
            "maxLength":"80",
            "type":"string",
            "description":"The data point name.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : creditAndCollectionsDataPoints-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SystemDerived":{
            "type":"string",
            "description":"Indicates whether this data point is system derived or automatically calculated by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SystemDerivedMeaning"
                ]
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the data point.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountBased":{
            "type":"string",
            "description":"Indicates whether this data point is amount-based.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DataPointCode"
                ]
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the data point was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the data point.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"400",
            "type":"string",
            "description":"The data point description.",
            "nullable":true,
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"The kind of information the data point provides.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryMeaning"
                ]
            }
        },
        "Scorable":{
            "type":"string",
            "description":"Indicates whether this data point may be used in scoring models.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ScorableMeaning"
                ]
            }
        },
        "Enabled":{
            "type":"string",
            "description":"Indicates whether this data point is enabled for use in scoring formulas or is displayed on the UI.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EnabledMeaning"
                ]
            }
        },
        "Source":{
            "type":"string",
            "description":"Identifies the source of the data point such as credit, collections, or third-party source.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SourceMeaning"
                ]
            }
        },
        "Name":{
            "maxLength":"80",
            "type":"string",
            "description":"The data point name.",
            "nullable":false,
            "x-queryable":true
        },
        "DataType":{
            "type":"string",
            "description":"The type of data of the data point value.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DataPointId":{
            "type":"integer",
            "description":"The data point unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the data point was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top