Jump to

• Request
• Response

Create a standard comment

post

/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• CategoryCd(required): string
  Title: Comment Category

  Maximum Length: 30

  The comment category ID of the record.
• Comments: string (byte)
  Title: Comments

  The text of the standard comment.
• EnabledFlag(required): boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled.
• FavoriteComment: array Favorite Comments
  Title: Favorite Comments

  The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.
• StandardCommentId(required): string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• SubcategoryCd(required): string
  Title: Comment Subcategory

  Maximum Length: 30

  The comment subcategory ID of the record.

{
    "required":[
        "CategoryCd",
        "EnabledFlag",
        "StandardCommentId",
        "SubcategoryCd"
    ],
    "type":"object",
    "properties":{
        "SubcategoryCd":{
            "title":"Comment Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "nullable":false
        },
        "FavoriteComment":{
            "title":"Favorite Comments",
            "type":"array",
            "description":"The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorStandardComments-FavoriteComment-item-post-request"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "CategoryCd":{
            "title":"Comment Category",
            "maxLength":30,
            "type":"string",
            "description":"The comment category ID of the record.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the standard comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StandardCommentId":{
            "title":"Comment Code",
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled.",
            "nullable":false
        }
    }
}

Nested Schema : Favorite Comments

Type: array

Title: Favorite Comments

The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.

Show Source

• Array of: object publicSectorStandardComments-FavoriteComment-item-post-request

{
    "title":"Favorite Comments",
    "type":"array",
    "description":"The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorStandardComments-FavoriteComment-item-post-request"
    }
}

Nested Schema : publicSectorStandardComments-FavoriteComment-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• StandardCommentId: string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "StandardCommentId":{
            "title":"Comment Code",
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "nullable":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:
  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 : publicSectorStandardComments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• CategoryCd: string
  Title: Comment Category

  Maximum Length: 30

  The comment category ID of the record.
• CategoryDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 300

  The description of the comment category of the record.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The preview text of the standard comment.
• Comments: string (byte)
  Title: Comments

  The text of the standard comment.
• CommentsPlain: string (byte)
  Read Only: true

  The text of the standard comment without the use of rich text formatting.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  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.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled.
• FavoriteComment: array Favorite Comments
  Title: Favorite Comments

  The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  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.
• StandardCommentId: string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• SubcategoryCd: string
  Title: Comment Subcategory

  Maximum Length: 30

  The comment subcategory ID of the record.
• SubcategoryDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 300

  The description of the comment subcategory of the record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubcategoryCd":{
            "title":"Comment Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "FavoriteComment":{
            "title":"Favorite Comments",
            "type":"array",
            "description":"The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorStandardComments-FavoriteComment-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The preview text of the standard comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CategoryCd":{
            "title":"Comment Category",
            "maxLength":30,
            "type":"string",
            "description":"The comment category ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the standard comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StandardCommentId":{
            "title":"Comment Code",
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "SubcategoryDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the comment subcategory of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentsPlain":{
            "type":"string",
            "description":"The text of the standard comment without the use of rich text formatting.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the comment category of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled.",
            "nullable":false,
            "x-queryable":true
        },
        "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 : Favorite Comments

Type: array

Title: Favorite Comments

The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.

Show Source

• Array of: object publicSectorStandardComments-FavoriteComment-item-response

{
    "title":"Favorite Comments",
    "type":"array",
    "description":"The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorStandardComments-FavoriteComment-item-response"
    }
}

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 : publicSectorStandardComments-FavoriteComment-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The preview text of the standard comment.
• Comments: string (byte)
  Title: Comments

  Read Only: true

  The text of the standard comment.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  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.
• StandardCommentId: string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• UserName: string
  Read Only: true

  Maximum Length: 100

  The name of the user who created the row.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The preview text of the standard comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the standard comment.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StandardCommentId":{
            "title":"Comment Code",
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "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."
        }
    }
}

Links

FavoriteComment

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment

Parameters:

• publicSectorStandardCommentsUniqID: $request.path.publicSectorStandardCommentsUniqID

The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.

Back to Top