Jump to

• Request
• Response

Get all checklists

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists

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 checklists using the specified checklist ID or description. Finder Variables:
    • value; string; The checklist ID or description.
  • PrimaryKey: Finds a checklist using the specified agency identifier and checklist identifier. Finder Variables:
    • AgencyId; integer; The agency identifier.
    • ChecklistId; string; The checklist identifier.
• 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 : publicSectorInspectionChecklists

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/publicSectorInspectionChecklists-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 publicSectorInspectionChecklists-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklists-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 : publicSectorInspectionChecklists-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with this inspection checklist.
• AssessmentType(optional): string
  Title: Assessment Type

  Maximum Length: 15

  The name of the assessment type used for the inspection checklist.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItem(optional): array Inspection Checklist Items
  Title: Inspection Checklist Items

  The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
• CommonComment(optional): string
  Title: Comment

  Maximum Length: 1000

  The comments for a specific inspection checklist.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the checklist was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of an inspection checklist.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the inspection checklist is available to be used. The default value is true.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the checklist.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Title: Major Violation

  Indicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.
• MaximumScore(optional): integer(int32)
  Title: Maximum Score

  The maximum score possible for an inspection checklist.
• MinimumPassingScore(optional): integer(int32)
  Title: Minimum Passing Score

  The minimum checklist score that is considered a passing result.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist is required. The default value is true.
• Score(optional): integer(int32)
  Title: Score

  The calculated score of the checklist.
• ScoringMethod(optional): string
  Title: Scoring Method

  Maximum Length: 15

  The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with this inspection checklist.",
            "title":"Agency ID"
        },
        "AssessmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the assessment type used for the inspection checklist.",
            "title":"Assessment Type"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItem":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklists-ChecklistItem-item"
            },
            "type":"array",
            "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
            "title":"Inspection Checklist Items"
        },
        "CommonComment":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments for a specific inspection checklist.",
            "title":"Comment"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of an inspection checklist.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the inspection checklist is available to be used. The default value is true.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the checklist.",
            "title":"Last Updated By"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.",
            "title":"Major Violation"
        },
        "MaximumScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum score possible for an inspection checklist.",
            "title":"Maximum Score"
        },
        "MinimumPassingScore":{
            "format":"int32",
            "type":"integer",
            "description":"The minimum checklist score that is considered a passing result.",
            "title":"Minimum Passing Score"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist is required. The default value is true.",
            "title":"Required"
        },
        "Score":{
            "format":"int32",
            "type":"integer",
            "description":"The calculated score of the checklist.",
            "title":"Score"
        },
        "ScoringMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.",
            "title":"Scoring Method"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Items

Type: array

Title: Inspection Checklist Items

The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.

Show Source

• Array of: object publicSectorInspectionChecklists-ChecklistItem-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklists-ChecklistItem-item"
    },
    "type":"array",
    "description":"The inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.",
    "title":"Inspection Checklist Items"
}

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 : publicSectorInspectionChecklists-ChecklistItem-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with this inspection checklist item.
• CategoryCode(optional): string
  Title: Category

  Maximum Length: 30

  The category of the inspection checklist item.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the checklist item was created.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The description of the inspection checklist item.
• Instruction(optional): array Inspection Checklist Instructions
  Title: Inspection Checklist Instructions

  The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist item was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the checklist item.
• links(optional): array Items
  Title: Items

  Link Relations
• MajorViolationFlag(optional): boolean
  Title: Major Violation

  Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. The default value is true.
• Score(optional): integer(int32)
  Title: Score

  The score that the checklist item received.
• SubcategoryCode(optional): string
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with this inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item.",
            "title":"Description"
        },
        "Instruction":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionChecklists-ChecklistItem-Instruction-item"
            },
            "type":"array",
            "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
            "title":"Inspection Checklist Instructions"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the checklist item.",
            "title":"Last Updated By"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false.",
            "title":"Major Violation"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. The default value is true.",
            "title":"Required"
        },
        "Score":{
            "format":"int32",
            "type":"integer",
            "description":"The score that the checklist item received.",
            "title":"Score"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item.",
            "title":"Subcategory"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Instructions

Type: array

Title: Inspection Checklist Instructions

The instructions resource is used for view, create, delete, or modify instructions. The instructions store specific instructions for inspecting a checklist item.

Show Source

• Array of: object publicSectorInspectionChecklists-ChecklistItem-Instruction-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionChecklists-ChecklistItem-Instruction-item"
    },
    "type":"array",
    "description":"The instructions resource is used for view, create, delete, or modify instructions. The  instructions store specific instructions for inspecting a checklist item.",
    "title":"Inspection Checklist Instructions"
}

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 : publicSectorInspectionChecklists-ChecklistItem-Instruction-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with these checklist item instructions.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The unique identifier for an inspection checklist.
• ChecklistItemId(optional): string
  Title: Checklist Item

  Maximum Length: 15

  The unique identifier for an inspection checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the instructions were created.
• InstructionCode(optional): string
  Title: Instructions

  Maximum Length: 15

  The code for the instructions that are associated with an item in an inspection checklist.
• InstructionText(optional): string
  Title: Instructional Text

  Maximum Length: 1000

  The text that includes the instructions for an inspection checklist item.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the instructions were last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The session login associated with the user who last updated the instructions.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with these checklist item instructions.",
            "title":"Agency ID"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for an inspection checklist item.",
            "title":"Checklist Item"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the instructions.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were created.",
            "title":"Creation Date"
        },
        "InstructionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code for the instructions that are associated with an item in an inspection checklist.",
            "title":"Instructions"
        },
        "InstructionText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text that includes the instructions for an inspection checklist item.",
            "title":"Instructional Text"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the instructions were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the instructions.",
            "title":"Last Updated By"
        },
        "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 : 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"
}

Back to Top