Jump to

• Request
• Response

Create an inspection group line

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorInspectionGroupLines-item

Type: object

Show Source

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

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who added an inspection to the group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when an inspection was added to the group.
• FinalInspectionFlag(optional): boolean
  Title: Final Inspection

  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGroup(optional): 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.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 15

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

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

  Maximum Length: 64

  The user who last updated an inspection in the group.
• links(optional): array Items
  Title: Items

  Link Relations
• Required(optional): boolean
  Title: Required

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who added an inspection to the group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when an inspection was added to the group.",
            "title":"Creation Date"
        },
        "FinalInspectionFlag":{
            "type":"boolean",
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "title":"Final Inspection"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a record type, such as a permit.",
            "title":"Inspection Group"
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a type of inspection, such as an electrical or plumbing inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when an inspection in the group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated an inspection in the group.",
            "title":"Last Updated By"
        },
        "Required":{
            "type":"boolean",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "title":"Required"
        },
        "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 : publicSectorInspectionGroupLines-item

Type: object

Show Source

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

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who added an inspection to the group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when an inspection was added to the group.
• FinalInspectionFlag(optional): boolean
  Title: Final Inspection

  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGroup(optional): 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.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 15

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

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

  Maximum Length: 64

  The user who last updated an inspection in the group.
• links(optional): array Items
  Title: Items

  Link Relations
• Required(optional): boolean
  Title: Required

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who added an inspection to the group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when an inspection was added to the group.",
            "title":"Creation Date"
        },
        "FinalInspectionFlag":{
            "type":"boolean",
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "title":"Final Inspection"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a record type, such as a permit.",
            "title":"Inspection Group"
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a type of inspection, such as an electrical or plumbing inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when an inspection in the group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated an inspection in the group.",
            "title":"Last Updated By"
        },
        "Required":{
            "type":"boolean",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "title":"Required"
        },
        "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