Jump to

• Request
• Response

Create a user comment

post

/fscmRestApi/resources/11.13.18.05/publicSectorUserComments

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActivityLogKey: integer (int64)
  The activity log key for the application for which user comments are accepted.
• AgencyId: integer (int32)
  Default Value: 1

  The unique ID of the public sector agency.
• CommentKey: integer (int64)
  The unique ID of the user comment.
• CommentPlain: string (byte)
  Rich-text comments saved as plain text.
• CommentText: string (byte)
  The comment content.
• LnpRecordId: string
  Maximum Length: 50

  The application record???s logical ID, generated based on the auto-number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The record???s unique ID.
• PartyId: integer (int64)
  The unique ID of the public user registered in the system.

{
    "type":"object",
    "properties":{
        "ActivityLogKey":{
            "type":"integer",
            "description":"The activity log key for the application for which user comments are accepted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique ID of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "CommentKey":{
            "type":"integer",
            "description":"The unique ID of the user comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CommentPlain":{
            "type":"string",
            "description":"Rich-text comments saved as plain text.",
            "format":"byte",
            "nullable":true
        },
        "CommentText":{
            "type":"string",
            "description":"The comment content.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The application record???s logical ID, generated based on the auto-number rule configured for the record type.",
            "nullable":false
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The record???s unique ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique ID of the public user registered in the system.",
            "format":"int64",
            "nullable":true,
            "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 : publicSectorUserComments-item-response

Type: object

Show Source

• ActivityGroupId: string
  Read Only: true

  Maximum Length: 30

  The activity group ID for the application for which public comments are accepted.
• ActivityId: string
  Read Only: true

  Maximum Length: 50

  The activity ID for the application for which public comments are accepted.
• ActivityLogKey: integer (int64)
  The activity log key for the application for which user comments are accepted.
• AgencyId: integer (int32)
  Default Value: 1

  The unique ID of the public sector agency.
• BaseDate: string (date)
  Read Only: true

  The activity start (base) date from which public comments are accepted for the specified application.
• CommentKey: integer (int64)
  The unique ID of the user comment.
• CommentPlain: string (byte)
  Rich-text comments saved as plain text.
• CommentPreview: string
  Read Only: true

  A preview of the comment.
• CommentText: string (byte)
  The comment content.
• CreatedByName: string
  Read Only: true

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

  The date the comment was created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50

  The application record???s logical ID, generated based on the auto-number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The record???s unique ID.
• PartyId: integer (int64)
  The unique ID of the public user registered in the system.
• PlannedDueDate: string (date)
  Read Only: true

  The planned activity due date through which public comments are accepted for the specified application.

{
    "type":"object",
    "properties":{
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The activity group ID for the application for which public comments are accepted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "maxLength":50,
            "type":"string",
            "description":"The activity ID for the application for which public comments are accepted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityLogKey":{
            "type":"integer",
            "description":"The activity log key for the application for which user comments are accepted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique ID of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BaseDate":{
            "type":"string",
            "description":"The activity start (base) date from which public comments are accepted for the specified application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentKey":{
            "type":"integer",
            "description":"The unique ID of the user comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPlain":{
            "type":"string",
            "description":"Rich-text comments saved as plain text.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "type":"string",
            "description":"A preview of the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommentText":{
            "type":"string",
            "description":"The comment content.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The application record???s logical ID, generated based on the auto-number rule configured for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The record???s unique ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique ID of the public user registered in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlannedDueDate":{
            "type":"string",
            "description":"The planned activity due date through which public comments are accepted for the specified application.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "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