Jump to

• Request
• Response

Update a related inspection

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRelatedInspections/{publicSectorRelatedInspectionsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorRelatedInspectionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- InspectionId, RelatedInspectionId and AgencyId ---for the Inspections with Related Inspections resource and used to uniquely identify an instance of Inspections with Related Inspections. The client should not generate the hash key value. Instead, the client should query on the Inspections with Related Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspections with Related Inspections.
  
  For example: publicSectorRelatedInspections?q=InspectionId=<value1>;RelatedInspectionId=<value2>;AgencyId=<value3>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRelatedInspections-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the public sector agency associated with the related inspection.
• InspectionId(optional): string
  Maximum Length: 50

  The unique identifier for a main inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• RelatedInspectionId(optional): string
  Maximum Length: 50

  The unique identifier for a related inspection.
• RelationshipType(optional): string
  Maximum Length: 15

  The static list of values (LOV) identifying how two inspections are related, such as REINSPECTION.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the related inspection."
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a main inspection."
        },
        "RelatedInspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a related inspection."
        },
        "RelationshipType":{
            "maxLength":15,
            "type":"string",
            "description":"The static list of values (LOV) identifying how two inspections are related, such as REINSPECTION."
        },
        "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

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

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the public sector agency associated with the related inspection.
• InspectionId(optional): string
  Maximum Length: 50

  The unique identifier for a main inspection.
• links(optional): array Items
  Title: Items

  Link Relations
• RelatedInspectionId(optional): string
  Maximum Length: 50

  The unique identifier for a related inspection.
• RelationshipType(optional): string
  Maximum Length: 15

  The static list of values (LOV) identifying how two inspections are related, such as REINSPECTION.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the related inspection."
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a main inspection."
        },
        "RelatedInspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a related inspection."
        },
        "RelationshipType":{
            "maxLength":15,
            "type":"string",
            "description":"The static list of values (LOV) identifying how two inspections are related, such as REINSPECTION."
        },
        "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