Jump to

• Request
• Response

Create an inspection reference entity cross references

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionReCrossReferences

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InspectionId: string
  Maximum Length: 50

  The identifier of the inspection.
• InspectionKey: integer (int64)
  The unique key of the inspection.
• InspectionResult: string
  Maximum Length: 25

  The result of the inspection.
• InstanceStringId: string
  Maximum Length: 1024

  The inspection grid instance string id.
• LnpInsReXrefKey: integer (int64)
  The unique identifier for the cross reference that is generated during a create action.
• LnpInsReXrefPuid: string
  Maximum Length: 480

  The unique identifier of the inspection reference entity transaction record in the legacy system.
• LnpRecordId: string
  Maximum Length: 50

  The identifier of the permit record.
• LnpRecordKey: integer (int64)
  The unique key of the permit record.
• MigratedDataFlag: string
  Maximum Length: 3

  The migration data flag for the transaction.
• ReInspKey: integer (int64)
  The key of the reference entity inspectable component.
• ReRecordId: string
  Maximum Length: 50

  The identifier of the reference entity.
• ReRecordKey: integer (int64)
  The unique key of the reference entity.

{
    "type":"object",
    "properties":{
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the inspection.",
            "nullable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique key of the inspection.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InspectionResult":{
            "maxLength":25,
            "type":"string",
            "description":"The result of the inspection.",
            "nullable":true
        },
        "InstanceStringId":{
            "maxLength":1024,
            "type":"string",
            "description":"The inspection grid instance string id.",
            "nullable":true
        },
        "LnpInsReXrefKey":{
            "type":"integer",
            "description":"The unique identifier for the cross reference that is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LnpInsReXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the inspection reference entity transaction record in the legacy system.",
            "nullable":false
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the permit record.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique key of the permit record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"The migration data flag for the transaction.",
            "nullable":true
        },
        "ReInspKey":{
            "type":"integer",
            "description":"The key of the reference entity inspectable component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the reference entity.",
            "nullable":true
        },
        "ReRecordKey":{
            "type":"integer",
            "description":"The unique key of the reference entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : publicSectorInspectionReCrossReferences-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  The date and time when the inspection reference entity cross reference is created.
• InspectionId: string
  Maximum Length: 50

  The identifier of the inspection.
• InspectionKey: integer (int64)
  The unique key of the inspection.
• InspectionResult: string
  Maximum Length: 25

  The result of the inspection.
• InstanceStringId: string
  Maximum Length: 1024

  The inspection grid instance string id.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the inspection reference entity cross reference was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpInsReXrefKey: integer (int64)
  The unique identifier for the cross reference that is generated during a create action.
• LnpInsReXrefPuid: string
  Maximum Length: 480

  The unique identifier of the inspection reference entity transaction record in the legacy system.
• LnpRecordId: string
  Maximum Length: 50

  The identifier of the permit record.
• LnpRecordKey: integer (int64)
  The unique key of the permit record.
• MigratedDataFlag: string
  Maximum Length: 3

  The migration data flag for the transaction.
• ReInspKey: integer (int64)
  The key of the reference entity inspectable component.
• ReRecordId: string
  Maximum Length: 50

  The identifier of the reference entity.
• ReRecordKey: integer (int64)
  The unique key of the reference entity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the inspection reference entity cross reference is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique key of the inspection.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionResult":{
            "maxLength":25,
            "type":"string",
            "description":"The result of the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "InstanceStringId":{
            "maxLength":1024,
            "type":"string",
            "description":"The inspection grid instance string id.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the inspection reference entity cross reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpInsReXrefKey":{
            "type":"integer",
            "description":"The unique identifier for the cross reference that is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LnpInsReXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the inspection reference entity transaction record in the legacy system.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the permit record.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique key of the permit record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"The migration data flag for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReInspKey":{
            "type":"integer",
            "description":"The key of the reference entity inspectable component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "ReRecordKey":{
            "type":"integer",
            "description":"The unique key of the reference entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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