Jump to

• Request
• Response

Create an inspection dependency

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionDependencies

Request

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

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the inspection dependency.
• DependentInspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The type of the dependent or prerequisite inspection.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The type of inspection for which dependencies or prerequisites are defined.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of inspection for which dependencies or prerequisites are defined.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection dependency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "DependentInspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the dependent or prerequisite inspection.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorInspectionDependencies-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the inspection dependency.
• DependentInspectionEnabled: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the dependent inspection type is available to be used. The value is defined in the inspection type and is read-only here.
• DependentInspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The type of the dependent or prerequisite inspection.
• InspectionEnabled: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection type is available to be used. The value is defined in the inspection type and is read-only here.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The type of inspection for which dependencies or prerequisites are defined.
• 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 type of inspection for which dependencies or prerequisites are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionEnabled":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection type is available to be used. The value is defined in the inspection type and is read-only here.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection dependency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DependentInspectionEnabled":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dependent inspection type is available to be used. The value is defined in the inspection type and is read-only here.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DependentInspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the dependent or prerequisite inspection.",
            "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."
        }
    }
}

Back to Top