Jump to

• Request
• Response

Get an inspection result code

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionResultCodes/{publicSectorInspectionResultCodesUniqID}

Request

Path Parameters

• publicSectorInspectionResultCodesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- InspectionType and AssessmentType ---for the Inspection Result Codes resource and used to uniquely identify an instance of Inspection Result Codes. The client should not generate the hash key value. Instead, the client should query on the Inspection Result Codes collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Result Codes.
  
  For example: publicSectorInspectionResultCodes?q=InspectionType=<value1>;AssessmentType=<value2>

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

Type: object

Show Source

• AssessmentCode(optional): string
  Maximum Length: 15

  The identifier for an assessment code. The assessment defines the possible outcome of an inspection.
• AssessmentType(optional): string
  Maximum Length: 15

  The identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.
• Description(optional): string
  Maximum Length: 100

  The description or name of the assessment type, which is defined by the agency. For example, an agency might use the assessment type ID PASSFAIL and description of Pass-Fail Assessment Type, which is defined using pass and fail assessment codes to identify the possible inspection outcomes.
• InspectionType(optional): string
  Maximum Length: 255

  The identifier for a type of inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• SystemResult(optional): string
  Maximum Length: 20

  The result code that is associated with an assessment code. The result code is used to determine whether an inspection receives the full score or not. The result codes Pass and Corrected receive the full score, and the result codes Fail and Other receive a score of zero.

{
    "properties":{
        "AssessmentCode":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier for an assessment code. The assessment defines the possible outcome of an inspection."
        },
        "AssessmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description or name of the assessment type, which is defined by the agency. For example, an agency might use the assessment type ID PASSFAIL and description of Pass-Fail Assessment Type, which is defined using pass and fail assessment codes to identify the possible inspection outcomes."
        },
        "InspectionType":{
            "maxLength":255,
            "type":"string",
            "description":"The identifier for a type of inspection."
        },
        "SystemResult":{
            "maxLength":20,
            "type":"string",
            "description":"The result code that is associated with an assessment code. The result code is used to determine whether an inspection receives the full score or not. The result codes Pass and Corrected receive the full score, and the result codes Fail and Other  receive a score of zero."
        },
        "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