Create a report
post
/crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures
Request
Path Parameters
-
DataSufficiencyJobId(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.
-
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
-
AdditionalMetadata: string
The additional metadata of the Report.
-
DataSufficiencyJobId: integer
(int64)
The job identification number of the data sufficiency report resource.
-
DataSufficiencyReportId: integer
(int64)
The report identification number of the AI data sufficiency report.
-
FeatureCode: string
Maximum Length:
200
The unique code of the feature. -
FeatureOwner: string
Maximum Length:
100
The owner of the feature.
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 : iisDatasufficiencyJobs-JobSelectedFeatures-item-response
Type:
Show Source
object
-
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.
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.