Jump to

• Request
• Response

Update a code enforcement inspection comment

patch

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

Request

Supported Media Types

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

Path Parameters

• publicSectorCodeEnforcementInspectionCommentsUniqID: integer
  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>

Body ()

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

Root Schema : publicSectorCodeEnforcementInspectionComments-item

Type: object

Show Source

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

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

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

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

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

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

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

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OriginalCreatedBy(optional): string
  The name of the user who created the comment.
• TransactionKey(optional): integer(int64)
  The unique identifier of the inspection for which the comment is being recorded.
• TransactionPuid(optional): string
  Maximum Length: 480

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the comment."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The identifier of the preview text of the comment.",
            "title":"Comment Preview"
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system comment identifier for the migrated data."
        },
        "CommentText":{
            "type":"string",
            "description":"The content of the comment.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "InspectionCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the comment."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment."
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspection for which the comment is being recorded."
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier that determines if the comment is visible to registered public users.",
            "title":"Hide from Public"
        },
        "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 : publicSectorCodeEnforcementInspectionComments-item

Type: object

Show Source

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

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

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

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

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

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

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

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

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OriginalCreatedBy(optional): string
  The name of the user who created the comment.
• TransactionKey(optional): integer(int64)
  The unique identifier of the inspection for which the comment is being recorded.
• TransactionPuid(optional): string
  Maximum Length: 480

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the comment."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The identifier of the preview text of the comment.",
            "title":"Comment Preview"
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system comment identifier for the migrated data."
        },
        "CommentText":{
            "type":"string",
            "description":"The content of the comment.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "InspectionCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the comment."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment."
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspection for which the comment is being recorded."
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier that determines if the comment is visible to registered public users.",
            "title":"Hide from Public"
        },
        "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