Jump to

• Request
• Response

Get an inspection checklist item

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionMobileChkListItems/{publicSectorInspectionMobileChkListItemsUniqID}

Request

Path Parameters

• publicSectorInspectionMobileChkListItemsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- SetupAgencyId, SetupChecklistId, SetupChecklistItemId and InspectionClItemKey ---for the Inspection Mobile Checklist Items resource and used to uniquely identify an instance of Inspection Mobile Checklist Items. The client should not generate the hash key value. Instead, the client should query on the Inspection Mobile Checklist Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Mobile Checklist Items.
  
  For example: publicSectorInspectionMobileChkListItems?q=SetupAgencyId=<value1>;SetupChecklistId=<value2>;SetupChecklistItemId=<value3>;InspectionClItemKey=<value4>

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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : publicSectorInspectionMobileChkListItems-item

Type: object

Show Source

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

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

  Maximum Length: 30

  The category of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

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

  Maximum Length: 15

  The unique identifier for the inspection checklist item.
• ChecklistItemName(optional): string
  Title: Checklist Item Name

  Maximum Length: 300

  The description of the inspection checklist item. This is copied from the checklist item setup table.
• ChecklistItemResult(optional): string
  Title: Result

  Maximum Length: 15

  The result for this checklist item, such as Pass, Fail, Yes, No, and so on.
• ChecklistItemScore(optional): integer(int32)
  Title: Score

  The score received for this checklist item.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the inspection checklist item was created.
• InspectionClItemKey(optional): integer(int64)
  The unique identifier for the inspection checklist item.
• InspectionId(optional): string
  Title: Inspection

  Maximum Length: 50

  The unique identifier for the inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The user who last updated the inspection 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 constitutes a major violation. The value is Y or N.
• PossibleScore(optional): integer(int32)
  Title: Possible Score

  The maximum possible score for the checklist item. This is copied from the checklist item setup table.
• RequiredFlag(optional): boolean
  Title: Required

  Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.
• SetupAgencyId(optional): integer(int32)
  The identifier for the public sector agency associated with the setup of inspection checklist item.
• SetupChecklistId(optional): string
  Maximum Length: 15

  The unique identifier for the setup of inspection checklist.
• SetupChecklistItemId(optional): string
  Maximum Length: 15

  The unique identifier for the setup of inspection checklist item.
• SetupMajorViolationFlag(optional): boolean
  Indicates whether a failing result for the checklist item constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. This is copied from the checklist item setup information.
• SetupScore(optional): integer(int32)
  The score that the checklist item received. This is copied from the checklist item setup information.
• SubcategoryCode(optional): string
  Title: Subcategory

  Maximum Length: 30

  The subcategory of the inspection checklist item. This is copied from the checklist item setup table.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection checklist item.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Category"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the inspection checklist item.",
            "title":"Checklist Item"
        },
        "ChecklistItemName":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Checklist Item Name"
        },
        "ChecklistItemResult":{
            "maxLength":15,
            "type":"string",
            "description":"The result for this checklist item, such as Pass, Fail, Yes, No, and so on.",
            "title":"Result"
        },
        "ChecklistItemScore":{
            "format":"int32",
            "type":"integer",
            "description":"The score received for this checklist item.",
            "title":"Score"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inspection checklist item.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist item was created.",
            "title":"Creation Date"
        },
        "InspectionClItemKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the inspection checklist item."
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the inspection.",
            "title":"Inspection"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist item was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inspection checklist item.",
            "title":"Last Updated By"
        },
        "MajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.",
            "title":"Major Violation"
        },
        "PossibleScore":{
            "format":"int32",
            "type":"integer",
            "description":"The maximum possible score for the checklist item. This is copied from the checklist item setup table.",
            "title":"Possible Score"
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N.",
            "title":"Required"
        },
        "SetupAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the setup of inspection checklist item."
        },
        "SetupChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the setup of inspection checklist."
        },
        "SetupChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the setup of inspection checklist item."
        },
        "SetupMajorViolationFlag":{
            "type":"boolean",
            "description":"Indicates whether a failing result for the checklist item constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. This is copied from the checklist item setup information."
        },
        "SetupScore":{
            "format":"int32",
            "type":"integer",
            "description":"The score that the checklist item received. This is copied from the checklist item setup information."
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory of the inspection checklist item. This is copied from the checklist item setup table.",
            "title":"Subcategory"
        },
        "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