Jump to

• Request
• Response

Update an inspection group line

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}

Request

Path Parameters

• publicSectorInspectionGroupLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, InspectionGroup and InspectionType ---for the Inspection Group Lines resource and used to uniquely identify an instance of Inspection Group Lines. The client should not generate the hash key value. Instead, the client should query on the Inspection Group Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Group Lines.
  
  For example: publicSectorInspectionGroupLines?q=AgencyId=<value1>;InspectionGroup=<value2>;InspectionType=<value3>

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DependentInspectionTypeCode: string
  Maximum Length: 2000

  The dependent inspection types defined for this inspection type
• DependentInspectionTypeDescr: string
  Maximum Length: 2500

  The descriptions of the dependent inspection types defined for this inspection type.
• FinalInspectionFlag: boolean
  Title: Final Inspection

  Maximum Length: 1

  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGrpLnDependency: array Inspection Type Dependencies
  Title: Inspection Type Dependencies

  The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
• Required: boolean
  Title: Required

  Maximum Length: 1

  Indicates whether the inspection is required. The default value is false.

{
    "type":"object",
    "properties":{
        "FinalInspectionFlag":{
            "title":"Final Inspection",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "nullable":true
        },
        "DependentInspectionTypeCode":{
            "maxLength":2000,
            "type":"string",
            "description":"The dependent inspection types defined for this inspection type",
            "nullable":true,
            "x-queryable":false
        },
        "Required":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "nullable":false
        },
        "InspectionGrpLnDependency":{
            "title":"Inspection Type Dependencies",
            "type":"array",
            "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-patch-request"
            }
        },
        "DependentInspectionTypeDescr":{
            "maxLength":2500,
            "type":"string",
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Inspection Type Dependencies

Type: array

Title: Inspection Type Dependencies

The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.

Show Source

• Array of: object schema

{
    "title":"Inspection Type Dependencies",
    "type":"array",
    "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorInspectionGroupLines-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier for a public sector agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when an inspection was added to the group.
• DependentInspectionTypeCode: string
  Maximum Length: 2000

  The dependent inspection types defined for this inspection type
• DependentInspectionTypeDescr: string
  Maximum Length: 2500

  The descriptions of the dependent inspection types defined for this inspection type.
• FinalInspectionFlag: boolean
  Title: Final Inspection

  Maximum Length: 1

  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGroup: string
  Title: Inspection Group

  Maximum Length: 15

  The unique identifier for a group of inspections that are associated with a record type, such as a permit.
• InspectionGrpLnDependency: array Inspection Type Dependencies
  Title: Inspection Type Dependencies

  The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The unique identifier for a type of inspection, such as an electrical or plumbing inspection.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when an inspection in the group was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Required: boolean
  Title: Required

  Maximum Length: 1

  Indicates whether the inspection is required. The default value is false.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a type of inspection, such as an electrical or plumbing inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when an inspection was added to the group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalInspectionFlag":{
            "title":"Final Inspection",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Required":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "InspectionGrpLnDependency":{
            "title":"Inspection Type Dependencies",
            "type":"array",
            "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-response"
            }
        },
        "DependentInspectionTypeDescr":{
            "maxLength":2500,
            "type":"string",
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DependentInspectionTypeCode":{
            "maxLength":2000,
            "type":"string",
            "description":"The dependent inspection types defined for this inspection type",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionGroup":{
            "title":"Inspection Group",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a record type, such as a permit.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when an inspection in the group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Inspection Type Dependencies

Type: array

Title: Inspection Type Dependencies

The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.

Show Source

• Array of: object publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-response

{
    "title":"Inspection Type Dependencies",
    "type":"array",
    "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorInspectionGroupLines-InspectionGrpLnDependency-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency associated with the inspection.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the dependent inspection type was added to the inspection type.
• DependentInspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The dependent inspection type for the inspection type.
• Description: string
  Read Only: true

  Maximum Length: 255

  The description of the inspection type.
• InspectionGroup: string
  Title: Inspection Group

  Maximum Length: 15

  The inspection group that includes the dependent inspection type.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The inspection type for which the dependent inspection type is defined.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the dependent inspection type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":15,
            "type":"string",
            "description":"The inspection type for which the dependent inspection type is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the dependent inspection type was added to the inspection type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the inspection type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionGroup":{
            "title":"Inspection Group",
            "maxLength":15,
            "type":"string",
            "description":"The inspection group that includes the dependent inspection type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the dependent inspection type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DependentInspectionType":{
            "title":"Inspection Type",
            "maxLength":15,
            "type":"string",
            "description":"The dependent inspection type for the inspection type.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

InspectionGrpLnDependency

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines/{publicSectorInspectionGroupLinesUniqID}/child/InspectionGrpLnDependency

Parameters:

• publicSectorInspectionGroupLinesUniqID: $request.path.publicSectorInspectionGroupLinesUniqID

The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.

Back to Top