Create a passing rule
post
/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules
Request
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
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier for the public sector entity to which this passing rule applies. -
Description(required): string
Title:
Description
Maximum Length:100
The description of the passing rule. -
PassingRule(required): string
Title:
Passing Rule
Maximum Length:15
The unique identifier for a passing rule. -
PassingRuleDetail: array
Passing Rule Details
Title:
Passing Rule Details
The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule.
Nested Schema : Passing Rule Details
Type:
array
Title:
Passing Rule Details
The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this scoring range applies. -
Description: string
Title:
Description
Maximum Length:100
The description of the passing rule details. -
MaximumScore: integer
(int32)
Title:
Maximum Score
The maxiumum inspection score in a range that results in a specified rating. -
MinimumScore: integer
(int32)
Title:
Minimum Score
The minimum inspection score in a range that results in a specified rating. -
NumberMajorViolations: integer
(int32)
Title:
Number of Major Violations
The number of major violations identified in a passing rule, used to determine the inspection result. -
PassingFlag: boolean
Title:
Pass
Maximum Length:1
Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false. -
PassingRule: string
Title:
Passing Rule
Maximum Length:15
The unique code for a passing rule. -
SequenceKey: integer
(int32)
Title:
Sequence Key
The secondary key used to make the data for the inspection passing rule details unique.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorPassingRules-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier for the public sector entity to which this passing rule applies. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the passing rule was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the passing rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the passing rule was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PassingRule: string
Title:
Passing Rule
Maximum Length:15
The unique identifier for a passing rule. -
PassingRuleDetail: array
Passing Rule Details
Title:
Passing Rule Details
The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Passing Rule Details
Type:
array
Title:
Passing Rule Details
The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule.
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.
Nested Schema : publicSectorPassingRules-PassingRuleDetail-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this scoring range applies. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the passing rule details were created. -
Description: string
Title:
Description
Maximum Length:100
The description of the passing rule details. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the passing rule details were last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumScore: integer
(int32)
Title:
Maximum Score
The maxiumum inspection score in a range that results in a specified rating. -
MinimumScore: integer
(int32)
Title:
Minimum Score
The minimum inspection score in a range that results in a specified rating. -
NumberMajorViolations: integer
(int32)
Title:
Number of Major Violations
The number of major violations identified in a passing rule, used to determine the inspection result. -
PassingFlag: boolean
Title:
Pass
Maximum Length:1
Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false. -
PassingRule: string
Title:
Passing Rule
Maximum Length:15
The unique code for a passing rule. -
SequenceKey: integer
(int32)
Title:
Sequence Key
The secondary key used to make the data for the inspection passing rule details unique.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PassingRuleDetail
-
Parameters:
- publicSectorPassingRulesUniqID:
$request.path.publicSectorPassingRulesUniqID
The passing rule details resource is used to view, create, delete, or modify a passing rule scoring range. There can be one or more scoring ranges for a given passing rule. - publicSectorPassingRulesUniqID: