Jump to

• Request
• Response

Update an entitlement activity comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivityComments/{CommentKey}

Request

Path Parameters

• CommentKey(required): integer(int64)
  The unique identifier for the entitlement activity comment.

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

• ActivityLogKey: integer (int64)
  The unique identifier for the entitlement activity log.
• CommentText: string (byte)
  Title: Comments

  The text of the entitlement activity comment.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The identifier to indicate if the entitlement activity comment is visible to the public.

{
    "type":"object",
    "properties":{
        "ActivityLogKey":{
            "type":"integer",
            "description":"The unique identifier for the entitlement activity log.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if the entitlement activity comment is visible to the public.",
            "nullable":false,
            "default":"Y"
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the entitlement activity comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• ActivityLogKey: integer (int64)
  The unique identifier for the entitlement activity log.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the entitlement activity comment.
• CommentId: integer (int64)
  The unique identifier reference for the common comments item.
• CommentKey: integer (int64)
  The unique identifier for the entitlement activity comment.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  Preview of the entitlement activity comment.
• CommentText: string (byte)
  Title: Comments

  The text of the entitlement activity comment.
• CreatedByName: string
  Title: Created By

  Read Only: true

  The user who created the entitlement activity comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the entitlement activity comment was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  The user who last updated the entitlement activity comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The identifier to indicate if the entitlement activity comment is visible to the public.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The user who created the entitlement activity comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityLogKey":{
            "type":"integer",
            "description":"The unique identifier for the entitlement activity log.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the entitlement activity comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"Preview of the entitlement activity 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
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the entitlement activity comment.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the entitlement activity comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CommentKey":{
            "type":"integer",
            "description":"The unique identifier for the entitlement activity comment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier reference for the common comments item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 to indicate if the entitlement activity comment is visible to the public.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the entitlement activity comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last date and time when the entitlement activity comment was 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