Jump to

• Request
• Response

Get all passing rules

get

/fscmRestApi/resources/11.13.18.05/publicSectorPassingRules

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • simpleSearchFinder: Finds passing rules using the specified passing rule name. Finder Variables:
    • value; string; The name of the passing rule.
  • PrimaryKey: Finds a passing rule using the specified agency ID and passing rule identifier. Finder Variables:
    • AgencyId; integer; The agency ID.
    • PassingRule; string; The identifier for the passing rule.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPassingRules

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorPassingRules-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPassingRules-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPassingRules-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested 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 rules resource is used to view, create, delete, or modify a passing rule. A passing rule provides pass and fail criteria to determine the result of an inspection.

{
    "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 rules resource is used to view, create, delete, or modify a passing rule. A passing rule provides pass and fail criteria to determine the result of an inspection.",
            "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 rules resource is used to view, create, delete, or modify a passing rule. A passing rule provides pass and fail criteria to determine the result of an inspection.

Show Source

• Array of: object publicSectorPassingRules-PassingRuleDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPassingRules-PassingRuleDetail-item"
    },
    "type":"array",
    "description":"The passing rules resource is used to view, create, delete, or modify a passing rule. A passing rule provides pass and fail criteria to determine the result of an inspection.",
    "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