Jump to

• Request
• Response

Update a report

patch

/crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}

Request

Path Parameters

• DataSufficiencyReportId(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=
• FeatureCode(required): string
  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

• AdditionalMetadata: string
  The additional metadata of the Report.

{
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The additional metadata of the Report.",
            "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 : iisFeatures-DatasufficiencyReports-item-response

Type: object

Show Source

• AdditionalMetadata: string
  The additional metadata of the Report.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the configuration for the AI data sufficiency job.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date and time when this configuration for the data sufficiency report is created.
• DataSufficiencyJobId: integer (int64)
  The job identification number of the data sufficiency report resource.
• DataSufficiencyLevel: string
  Read Only: true

  Maximum Length: 32

  The data sufficiency level of the feature.
• DataSufficiencyReport: string
  Read Only: true

  The data sufficiency report of the feature.
• DataSufficiencyReportId: integer (int64)
  The report identification number of the AI data sufficiency report.
• DataSufficiencyTotalScore: integer (int64)
  Read Only: true

  The total score of the data sufficiency check for the feature.
• FeatureCode: string
  Maximum Length: 200

  The unique code of the feature.
• FeatureOwner: string
  Maximum Length: 100

  The owner of the feature.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates the date and time of the last update to the configuration in the data sufficiency report.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the configuration in the data sufficiency report.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the configuration in data sufficiency report.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReportStatus: string
  Read Only: true

  Maximum Length: 100

  Default Value: DRAFT

  The status of the report.

{
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The additional metadata of the Report.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the configuration for the AI data sufficiency job.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time when this configuration for the data sufficiency report is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSufficiencyJobId":{
            "type":"integer",
            "description":"The job identification number of the data sufficiency report resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataSufficiencyLevel":{
            "maxLength":32,
            "type":"string",
            "description":"The data sufficiency level of the feature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSufficiencyReport":{
            "type":"string",
            "description":"The data sufficiency report of the feature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSufficiencyReportId":{
            "type":"integer",
            "description":"The report identification number of the AI data sufficiency report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataSufficiencyTotalScore":{
            "type":"integer",
            "description":"The total score of the data sufficiency check for the feature.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "FeatureCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique code of the feature.",
            "nullable":false,
            "x-queryable":true
        },
        "FeatureOwner":{
            "maxLength":100,
            "type":"string",
            "description":"The owner of the feature.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update to the configuration in the data sufficiency report.",
            "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 configuration in data sufficiency report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the configuration in the data sufficiency report.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The status of the report.",
            "nullable":false,
            "readOnly":true,
            "default":"DRAFT",
            "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