Jump to

• Request
• Response

Create a passing rule

post

/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorPassingRules-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier for the public sector entity to which this passing rule applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the passing rule.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the passing rule was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the passing rule.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the passing rule was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the passing rule.
• links(optional): array Items
  Title: Items

  Link Relations
• PassingRule(optional): string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule.
• PassingRuleDetail(optional): 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this passing rule applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the passing rule.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the passing rule was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the passing rule.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the passing rule.",
            "title":"Last Updated By"
        },
        "PassingRule":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a passing rule.",
            "title":"Passing Rule"
        },
        "PassingRuleDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorPassingRules-PassingRuleDetail-item"
            },
            "type":"array",
            "description":"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.",
            "title":"Passing Rule Details"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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

• Array of: object publicSectorPassingRules-PassingRuleDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPassingRules-PassingRuleDetail-item"
    },
    "type":"array",
    "description":"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.",
    "title":"Passing Rule Details"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorPassingRules-PassingRuleDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this scoring range applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the passing rule details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the passing rule details were created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the passing rule details.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the passing rule details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the passing rule details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maxiumum inspection score in a range that results in a specified rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum inspection score in a range that results in a specified rating.
• NumberMajorViolations(optional): integer(int32)
  Title: Number of Major Violations

  The number of major violations identified in a passing rule, used to determine the inspection result.
• PassingFlag(optional): boolean
  Title: Pass

  Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.
• PassingRule(optional): string
  Title: Passing Rule

  Maximum Length: 15

  The unique code for a passing rule.
• SequenceKey(optional): integer(int32)
  Title: Sequence Key

  The secondary key used to make the data for the inspection passing rule details unique.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this scoring range applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the passing rule details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule details were created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the passing rule details.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the passing rule details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maxiumum inspection score in a range that results in a specified rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum inspection score in a range that results in a specified rating.",
            "title":"Minimum Score"
        },
        "NumberMajorViolations":{
            "format":"int32",
            "type":"integer",
            "description":"The number of major violations identified in a passing rule, used to determine the inspection result.",
            "title":"Number of Major Violations"
        },
        "PassingFlag":{
            "type":"boolean",
            "description":"Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.",
            "title":"Pass"
        },
        "PassingRule":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code for a passing rule.",
            "title":"Passing Rule"
        },
        "SequenceKey":{
            "format":"int32",
            "type":"integer",
            "description":"The secondary key used to make the data for the inspection passing rule details unique.",
            "title":"Sequence Key"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPassingRules-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier for the public sector entity to which this passing rule applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the passing rule.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the passing rule was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the passing rule.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the passing rule was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the passing rule.
• links(optional): array Items
  Title: Items

  Link Relations
• PassingRule(optional): string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule.
• PassingRuleDetail(optional): 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.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier for the public sector entity to which this passing rule applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the passing rule.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the passing rule was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the passing rule.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the passing rule.",
            "title":"Last Updated By"
        },
        "PassingRule":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a passing rule.",
            "title":"Passing Rule"
        },
        "PassingRuleDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorPassingRules-PassingRuleDetail-item"
            },
            "type":"array",
            "description":"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.",
            "title":"Passing Rule Details"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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

• Array of: object publicSectorPassingRules-PassingRuleDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPassingRules-PassingRuleDetail-item"
    },
    "type":"array",
    "description":"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.",
    "title":"Passing Rule Details"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorPassingRules-PassingRuleDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The agency identifier of the public sector entity to which this scoring range applies.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the passing rule details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the passing rule details were created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the passing rule details.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the passing rule details were last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the passing rule details.
• links(optional): array Items
  Title: Items

  Link Relations
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maxiumum inspection score in a range that results in a specified rating.
• MinimumScore(optional): integer(int32)
  Title: Minimum Score

  The minimum inspection score in a range that results in a specified rating.
• NumberMajorViolations(optional): integer(int32)
  Title: Number of Major Violations

  The number of major violations identified in a passing rule, used to determine the inspection result.
• PassingFlag(optional): boolean
  Title: Pass

  Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.
• PassingRule(optional): string
  Title: Passing Rule

  Maximum Length: 15

  The unique code for a passing rule.
• SequenceKey(optional): integer(int32)
  Title: Sequence Key

  The secondary key used to make the data for the inspection passing rule details unique.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this scoring range applies.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the passing rule details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule details were created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the passing rule details.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the passing rule details were last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the passing rule details.",
            "title":"Last Updated By"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maxiumum inspection score in a range that results in a specified rating.",
            "title":"Maximum Score"
        },
        "MinimumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum inspection score in a range that results in a specified rating.",
            "title":"Minimum Score"
        },
        "NumberMajorViolations":{
            "format":"int32",
            "type":"integer",
            "description":"The number of major violations identified in a passing rule, used to determine the inspection result.",
            "title":"Number of Major Violations"
        },
        "PassingFlag":{
            "type":"boolean",
            "description":"Indicates whether the combined scoring range and number of violations constitute a passing inspection result. The default value is false.",
            "title":"Pass"
        },
        "PassingRule":{
            "maxLength":15,
            "type":"string",
            "description":"The unique code for a passing rule.",
            "title":"Passing Rule"
        },
        "SequenceKey":{
            "format":"int32",
            "type":"integer",
            "description":"The secondary key used to make the data for the inspection passing rule details unique.",
            "title":"Sequence Key"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top