Jump to

• Request
• Response

Get a standard comment

get

/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}

Request

Path Parameters

• publicSectorStandardCommentsUniqID: string
  Identifier to Standard Comments

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

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

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

  Maximum Length: 30

  The comment category ID of the record.
• CommentPreview(optional): string
  Title: Comment Preview

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

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

  Maximum Length: 64

  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.
• EnabledFlag(optional): string
  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(optional): array Favorite Comments
  Title: Favorite Comments

  The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• StandardCommentId(optional): string
  Title: Comment Code

  Maximum Length: 200

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

  Maximum Length: 30

  The comment subcategory ID of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment category ID of the record.",
            "title":"Comment Category"
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the standard comment.",
            "title":"Comment Preview"
        },
        "Comments":{
            "type":"string",
            "description":"The text of the standard comment.",
            "title":"Comments"
        },
        "CommentsPlain":{
            "type":"string",
            "description":"The text of the standard comment without the use of rich text formatting."
        },
        "CreatedBy":{
            "maxLength":64,
            "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"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled.",
            "title":"Enabled"
        },
        "FavoriteComment":{
            "items":{
                "$ref":"#/definitions/publicSectorStandardComments-FavoriteComment-item"
            },
            "type":"array",
            "description":"The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.",
            "title":"Favorite Comments"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "StandardCommentId":{
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "title":"Comment Code"
        },
        "SubcategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "title":"Comment Subcategory"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Favorite Comments

Type: array

Title: Favorite Comments

The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.

Show Source

• Array of: object publicSectorStandardComments-FavoriteComment-item

{
    "items":{
        "$ref":"#/definitions/publicSectorStandardComments-FavoriteComment-item"
    },
    "type":"array",
    "description":"The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.",
    "title":"Favorite Comments"
}

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

Type: object

Show Source

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

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

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

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

  Maximum Length: 64

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

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

  Maximum Length: 64

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

  Link Relations
• StandardCommentId(optional): string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• UserName(optional): string
  Maximum Length: 100

  The name of the user who created the row.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the standard comment.",
            "title":"Comment Preview"
        },
        "Comments":{
            "type":"string",
            "description":"The text of the standard comment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "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"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "StandardCommentId":{
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "title":"Comment Code"
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "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