Jump to

• Request
• Response

Update a code enforcement inspection comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}

Request

Path Parameters

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

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 ()

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

Root Schema : schema

Type: object

Show Source

• CommentPuid: string
  Maximum Length: 480

  The legacy system comment identifier for the migrated data.
• CommentText: string (byte)
  Title: Comments

  The content of the comment.
• TransactionPuid: string
  Maximum Length: 480

  The legacy system inspection transaction identifier for the migrated data.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The identifier that determines if the comment is visible to registered public users.

{
    "type":"object",
    "properties":{
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"The identifier that determines if the comment is visible to registered public users.",
            "nullable":false,
            "default":"Y"
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system comment identifier for the migrated data.",
            "nullable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The content of the comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• CommentId: integer (int64)
  The identifier of the comment.
• CommentKey: integer (int64)
  The unique identifier of the comment.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The identifier of the preview text of the comment.
• CommentPuid: string
  Maximum Length: 480

  The legacy system comment identifier for the migrated data.
• CommentText: string (byte)
  Title: Comments

  The content of the comment.
• CreatedByName: string
  Title: Created By

  Read Only: true

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• InspectionCommentId: integer (int64)
  The unique identifier of the comment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

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

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• TransactionKey: integer (int64)
  The unique identifier of the inspection for which the comment is being recorded.
• TransactionPuid: string
  Maximum Length: 480

  The legacy system inspection transaction identifier for the migrated data.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The identifier that determines if the comment is visible to registered public users.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCommentId":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The identifier of the preview text of the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the inspection for which the comment is being recorded.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The content of the comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentKey":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system comment identifier for the migrated data.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"The identifier that determines if the comment is visible to registered public users.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "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