Jump to

• Request
• Response

Update a selected field

patch

/crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics/{JobRunId}

Request

Path Parameters

• JobId(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=
• JobRunId(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: string
  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: string
  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

• AdditionalMetadataJson: string
  The additional JSON details of the machine learning model.
• DataSourceName: string
  Maximum Length: 700

  The name of the data source associated with the use case.
• DataSourceSQL: string
  The SQL query for the data source associated with the use case.
• DataSourceType: string
  Maximum Length: 80

  The type of the data source associated with the use case.
• ExplainabilityMetrics: string
  The metrics used to explain the model and its performance.
• JobId: integer (int64)
  The unique identifier used to find the model.
• JobName: string
  Maximum Length: 2000

  The name of the machine learning model.
• JobRunId: integer (int64)
  The unique identifier of the job run.
• ModelAccuracy: string
  Maximum Length: 200

  The accuracy of the machine learning model.
• ModelStatus: string
  Maximum Length: 20

  The status of the machine learning model.
• ModelType: string
  Maximum Length: 200

  The model type associated with the use case. The type of the model depends on the task you want to perform.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• RangeValues: string
  The range of possible values for underlying model attributes.
• SelectedAlgorithm: string
  Maximum Length: 200

  The algorithm selected for the use case.

{
    "type":"object",
    "properties":{
        "AdditionalMetadataJson":{
            "type":"string",
            "description":"The additional JSON details of the machine learning model.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSourceName":{
            "maxLength":700,
            "type":"string",
            "description":"The name of the data source associated with the use case.",
            "nullable":false
        },
        "DataSourceSQL":{
            "type":"string",
            "description":"The SQL query for the data source associated with the use case.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSourceType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of the data source associated with the use case.",
            "nullable":false
        },
        "ExplainabilityMetrics":{
            "type":"string",
            "description":"The metrics used to explain the model and its performance.",
            "nullable":true,
            "x-queryable":false
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "JobName":{
            "maxLength":2000,
            "type":"string",
            "description":"The name of the machine learning model.",
            "nullable":false
        },
        "JobRunId":{
            "type":"integer",
            "description":"The unique identifier of the job run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ModelAccuracy":{
            "maxLength":200,
            "type":"string",
            "description":"The accuracy of the machine learning model.",
            "nullable":true
        },
        "ModelStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true
        },
        "ModelType":{
            "maxLength":200,
            "type":"string",
            "description":"The model type associated with the use case. The type of the model depends on the task you want to perform.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RangeValues":{
            "type":"string",
            "description":"The range of possible values for underlying model attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "SelectedAlgorithm":{
            "maxLength":200,
            "type":"string",
            "description":"The algorithm selected for the use case.",
            "nullable":true
        }
    }
}

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 : salesMLModels-ZcaOmlJobStatistics-item-response

Type: object

Show Source

• AdditionalMetadataJson: string
  The additional JSON details of the machine learning model.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DataSourceName: string
  Maximum Length: 700

  The name of the data source associated with the use case.
• DataSourceSQL: string
  The SQL query for the data source associated with the use case.
• DataSourceType: string
  Maximum Length: 80

  The type of the data source associated with the use case.
• ExplainabilityMetrics: string
  The metrics used to explain the model and its performance.
• JobId: integer (int64)
  The unique identifier used to find the model.
• JobName: string
  Maximum Length: 2000

  The name of the machine learning model.
• JobRunId: integer (int64)
  The unique identifier of the job run.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the model record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the model.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the model.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModelAccuracy: string
  Maximum Length: 200

  The accuracy of the machine learning model.
• ModelStatus: string
  Maximum Length: 20

  The status of the machine learning model.
• ModelType: string
  Maximum Length: 200

  The model type associated with the use case. The type of the model depends on the task you want to perform.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• RangeValues: string
  The range of possible values for underlying model attributes.
• SelectedAlgorithm: string
  Maximum Length: 200

  The algorithm selected for the use case.

{
    "type":"object",
    "properties":{
        "AdditionalMetadataJson":{
            "type":"string",
            "description":"The additional JSON details of the machine learning model.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceName":{
            "maxLength":700,
            "type":"string",
            "description":"The name of the data source associated with the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "DataSourceSQL":{
            "type":"string",
            "description":"The SQL query for the data source associated with the use case.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSourceType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of the data source associated with the use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ExplainabilityMetrics":{
            "type":"string",
            "description":"The metrics used to explain the model and its performance.",
            "nullable":true,
            "x-queryable":false
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "maxLength":2000,
            "type":"string",
            "description":"The name of the machine learning model.",
            "nullable":false,
            "x-queryable":true
        },
        "JobRunId":{
            "type":"integer",
            "description":"The unique identifier of the job run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelAccuracy":{
            "maxLength":200,
            "type":"string",
            "description":"The accuracy of the machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the machine learning model.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelType":{
            "maxLength":200,
            "type":"string",
            "description":"The model type associated with the use case. The type of the model depends on the task you want to perform.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RangeValues":{
            "type":"string",
            "description":"The range of possible values for underlying model attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "SelectedAlgorithm":{
            "maxLength":200,
            "type":"string",
            "description":"The algorithm selected for the use case.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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