Jump to

• Request
• Response

Get an inspection

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}

Request

Path Parameters

• publicSectorCodeEnforcementInspectionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- TransactionKey and TransactionId ---for the Code Enforcement Inspections resource and used to uniquely identify an instance of Code Enforcement Inspections. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspections.
  
  For example: publicSectorCodeEnforcementInspections?q=TransactionKey=<value1>;TransactionId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AdditionalPayload: string
  Indicates the additional payload for the inspection outcome.
• AgencyId: integer (int32)
  Default Value: 1

  The identifier of the public sector agency.
• AssignedId: integer (int64)
  Title: Assigned To

  The identifier of the Code Enforcement officer.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• ExtensionCount: integer
  Read Only: true

  The number of extensions applied for a case.
• ExtensionDate: string (date)
  The new inspection due date.
• InspectionActDate: string (date)
  Title: Inspection Completion Date

  The date on which the inspection was actually carried out.
• InspectionCount: integer (int32)
  Title: Inspection Count

  The number of inspections conducted for an incident or a case.
• InspectionDueDate: string (date)
  Title: Due Date

  The date on which the inspection is due.
• InspectionOutcome: string
  Title: Inspection Outcome

  Maximum Length: 15

  The outcome of the inspection.
• InspectionOutcomeReason: string
  Title: Outcome Reason

  Maximum Length: 100

  The reason for the inspection outcome.
• InspectionSchDate: string (date)
  Title: Scheduled Date

  The date on which the inspection is scheduled.
• InspectionStatus: string
  Title: Inspection Status

  Maximum Length: 8

  The identifier of the inspections status.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultedBy: string
  Maximum Length: 64

  The name of the user who resulted the inspection.
• SourceTransactionId: string
  Title: Source Transaction Code

  Maximum Length: 50

  Default Value: D

  The unique identifier of the source transaction from which the inspection originated.
• SourceTransactionKey: integer (int64)
  Title: Source Transaction Key

  Default Value: 0

  The auto generated unique identifier of the source transaction from which the inspection originated.
• SourceTransactionPuid: string
  Maximum Length: 480

  The legacy system source transaction identifier for the migrated data.
• SourceTransactionStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the source transaction after the inspection due date is extended.
• SourceTransactionType: string
  Title: Source Transaction Type

  Maximum Length: 15

  Indicates the transaction type from which the inspection originated.
• TransactionId: string
  Title: Inspection Code

  Maximum Length: 50

  Default Value: NEXT

  The unique identifier of the inspection.
• TransactionKey: integer (int64)
  The auto generated unique identifier of the inspection.
• TransactionPuid: string
  Maximum Length: 480

  The legacy system inspection transaction identifier for the migrated data.
• UserName: string
  Maximum Length: 64

  The legacy system user assigned to the inspection transaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The auto generated unique identifier of the inspection.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "InspectionCount":{
            "title":"Inspection Count",
            "type":"integer",
            "description":"The number of inspections conducted for an incident or a case.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "InspectionSchDate":{
            "title":"Scheduled Date",
            "type":"string",
            "description":"The date on which the inspection is scheduled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date on which the inspection is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionType":{
            "title":"Source Transaction Type",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the transaction type from which the inspection originated.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system source transaction identifier for the migrated data.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedId":{
            "title":"Assigned To",
            "type":"integer",
            "description":"The identifier of the Code Enforcement officer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who resulted the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "title":"Inspection Status",
            "maxLength":8,
            "type":"string",
            "description":"The identifier of the inspections status.",
            "nullable":false,
            "x-queryable":true
        },
        "InspectionOutcome":{
            "title":"Inspection Outcome",
            "maxLength":15,
            "type":"string",
            "description":"The outcome of the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "title":"Source Transaction Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the source transaction from which the inspection originated.",
            "nullable":true,
            "default":"D",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceTransactionKey":{
            "title":"Source Transaction Key",
            "type":"integer",
            "description":"The auto generated unique identifier of the source transaction from which the inspection originated.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionActDate":{
            "title":"Inspection Completion Date",
            "type":"string",
            "description":"The date on which the inspection was actually carried out.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the source transaction after the inspection due date is extended.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":64,
            "type":"string",
            "description":"The legacy system user assigned to the inspection transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtensionDate":{
            "type":"string",
            "description":"The new inspection due date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Inspection Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the inspection.",
            "nullable":false,
            "default":"NEXT",
            "x-queryable":true
        },
        "ExtensionCount":{
            "type":"integer",
            "description":"The number of extensions applied for a case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionOutcomeReason":{
            "title":"Outcome Reason",
            "maxLength":100,
            "type":"string",
            "description":"The reason for the inspection outcome.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPayload":{
            "type":"string",
            "description":"Indicates the additional payload for the inspection outcome.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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