Jump to

• Request
• Response

Create a selected field

post

/crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields

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=

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.
• Upsert-Mode: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdditionalMetadata: string
  The object version number for the record.
• FieldDataType(required): string
  Maximum Length: 200

  The date type of the selected field such as boolean, string, and so on.
• FieldName(required): string
  Maximum Length: 800

  The name of the field associated with the ML model.
• FieldTitle: string
  Maximum Length: 800

  The display name of the available field.
• IsFeature: string
  Maximum Length: 20

  Indicates if the field is a feature or not. The valid values are Yes, No, or Null.
• JobId(required): integer (int64)
  The unique identifier used to find the model.
• ObjectRelationCode: string
  Maximum Length: 800

  The object relation code for the related object relationship.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• UsecaseCode(required): string
  Maximum Length: 200

  The unique identifier of the use case used to find a use case.
• ZcaOmlJobRules: array Model Validation and Transformation Rules
  Title: Model Validation and Transformation Rules

  Sales Machine Learning Model Rules

{
    "required":[
        "FieldDataType",
        "FieldName",
        "JobId",
        "UsecaseCode"
    ],
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The date type of the selected field such as boolean, string, and so on.",
            "nullable":false
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the field associated with the ML model.",
            "nullable":false
        },
        "FieldTitle":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":true
        },
        "IsFeature":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates if the field is a feature or not. The valid values are Yes, No, or Null.",
            "nullable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectRelationCode":{
            "maxLength":800,
            "type":"string",
            "description":"The object relation code for the related object relationship.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false
        },
        "ZcaOmlJobRules":{
            "title":"Model Validation and Transformation Rules",
            "type":"array",
            "description":"Sales Machine Learning Model Rules",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request"
            }
        }
    }
}

Nested Schema : Model Validation and Transformation Rules

Type: array

Title: Model Validation and Transformation Rules

Sales Machine Learning Model Rules

Show Source

• Array of: object salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request

{
    "title":"Model Validation and Transformation Rules",
    "type":"array",
    "description":"Sales Machine Learning Model Rules",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request"
    }
}

Nested Schema : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-post-request

Type: object

Show Source

• FieldName: string
  Maximum Length: 800

  The name of the selected field.
• JobId: integer (int64)
  The unique identifier of the model.
• JobRuleId: integer (int64)
  The unique identifier of the validation or transformation rule.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• RuleCode: string
  Maximum Length: 200

  The unique identifier of the validation or transformation rule.
• RuleValue: string
  The value of the rule associated with the model.
• UsecaseCode: string
  Maximum Length: 200

  The unique identifier of the use case.

{
    "type":"object",
    "properties":{
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the selected field.",
            "nullable":false
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "JobRuleId":{
            "type":"integer",
            "description":"The unique identifier of the validation or transformation rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RuleCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the validation or transformation rule.",
            "nullable":false
        },
        "RuleValue":{
            "type":"string",
            "description":"The value of the rule associated with the model.",
            "nullable":true,
            "x-queryable":false
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case.",
            "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 : salesMLModels-ZcaOmlJobsSelFields-item-response

Type: object

Show Source

• AdditionalMetadata: string
  The object version number for the record.
• 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.
• FieldDataType: string
  Maximum Length: 200

  The date type of the selected field such as boolean, string, and so on.
• FieldName: string
  Maximum Length: 800

  The name of the field associated with the ML model.
• FieldTitle: string
  Maximum Length: 800

  The display name of the available field.
• IsFeature: string
  Maximum Length: 20

  Indicates if the field is a feature or not. The valid values are Yes, No, or Null.
• JobId: integer (int64)
  The unique identifier used to find the model.
• 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.
• ObjectRelationCode: string
  Maximum Length: 800

  The object relation code for the related object relationship.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• UsecaseCode: string
  Maximum Length: 200

  The unique identifier of the use case used to find a use case.
• ZcaOmlJobRules: array Model Validation and Transformation Rules
  Title: Model Validation and Transformation Rules

  Sales Machine Learning Model Rules

{
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "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
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The date type of the selected field such as boolean, string, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the field associated with the ML model.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldTitle":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":true,
            "x-queryable":true
        },
        "IsFeature":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates if the field is a feature or not. The valid values are Yes, No, or Null.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier used to find the model.",
            "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
        },
        "ObjectRelationCode":{
            "maxLength":800,
            "type":"string",
            "description":"The object relation code for the related object relationship.",
            "nullable":true,
            "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
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "x-queryable":true
        },
        "ZcaOmlJobRules":{
            "title":"Model Validation and Transformation Rules",
            "type":"array",
            "description":"Sales Machine Learning Model Rules",
            "items":{
                "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response"
            }
        },
        "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 : Model Validation and Transformation Rules

Type: array

Title: Model Validation and Transformation Rules

Sales Machine Learning Model Rules

Show Source

• Array of: object salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response

{
    "title":"Model Validation and Transformation Rules",
    "type":"array",
    "description":"Sales Machine Learning Model Rules",
    "items":{
        "$ref":"#/components/schemas/salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response"
    }
}

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."
        }
    }
}

Nested Schema : salesMLModels-ZcaOmlJobsSelFields-ZcaOmlJobRules-item-response

Type: object

Show Source

• 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.
• FieldName: string
  Maximum Length: 800

  The name of the selected field.
• JobId: integer (int64)
  The unique identifier of the model.
• JobRuleId: integer (int64)
  The unique identifier of the validation or transformation rule.
• 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.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• RuleCode: string
  Maximum Length: 200

  The unique identifier of the validation or transformation rule.
• RuleValue: string
  The value of the rule associated with the model.
• UsecaseCode: string
  Maximum Length: 200

  The unique identifier of the use case.

{
    "type":"object",
    "properties":{
        "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
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The name of the selected field.",
            "nullable":false,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"The unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobRuleId":{
            "type":"integer",
            "description":"The unique identifier of the validation or transformation rule.",
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RuleCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the validation or transformation rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleValue":{
            "type":"string",
            "description":"The value of the rule associated with the model.",
            "nullable":true,
            "x-queryable":false
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case.",
            "nullable":false,
            "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"
    }
}

Links

ZcaOmlJobRules

Operation: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules

Parameters:

• JobId: $request.path.JobId
• ZcaOmlJobsSelFieldsUniqID: $request.path.ZcaOmlJobsSelFieldsUniqID

Sales Machine Learning Model Rules

Back to Top