Jump to

• Request
• Response

Update a comment application group option

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommentApplicationGroupOptions/{publicSectorCommentApplicationGroupOptionsUniqID}

Request

Path Parameters

• publicSectorCommentApplicationGroupOptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and ApplicationGroupCode ---for the Comment Application Group Options resource and used to uniquely identify an instance of Comment Application Group Options. The client should not generate the hash key value. Instead, the client should query on the Comment Application Group Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Comment Application Group Options.
  
  For example: publicSectorCommentApplicationGroupOptions?q=AgencyId=<value1>;ApplicationGroupCode=<value2>

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 ()

Root Schema : schema

Type: object

Show Source

• DefaultVisibilityFlag: string
  Title: Private

  Maximum Length: 1

  Default Value: N

  The identifier for the default visibility of comments.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  The identifier for the deleted row.
• ModuleId: string
  Maximum Length: 32

  The identifier of the record module.
• ObjectVersionNumber: integer (int32)
  The version number of the record.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.
• SeedDataSource: string
  Maximum Length: 512

  Indicates the data source for the seed data.

{
    "type":"object",
    "properties":{
        "DefaultVisibilityFlag":{
            "title":"Private",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier for the default visibility of comments.",
            "nullable":false,
            "default":"N"
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The identifier of the record module.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Indicates the data source for the seed data.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The identifier for the deleted row.",
            "nullable":false,
            "default":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 : publicSectorCommentApplicationGroupOptions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency ID of the record.
• ApplicationGroupCode: string
  Title: Comment Application Group

  Maximum Length: 30

  The identifier of the application group in the record.
• ApplicationGroupName: string
  Read Only: true

  Maximum Length: 255

  The name of the application group in the record.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the row was created.
• DefaultVisibilityFlag: string
  Title: Private

  Maximum Length: 1

  Default Value: N

  The identifier for the default visibility of comments.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  The identifier for the deleted row.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The name of the logged in user when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The identifier of the record module.
• ObjectVersionNumber: integer (int32)
  The version number of the record.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.
• SeedDataSource: string
  Maximum Length: 512

  Indicates the data source for the seed data.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Indicates the data source for the seed data.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ApplicationGroupCode":{
            "title":"Comment Application Group",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the application group in the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicationGroupName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the application group in the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultVisibilityFlag":{
            "title":"Private",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier for the default visibility of comments.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The identifier of the record module.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The identifier for the deleted row.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The name of the logged in user when the row was last updated.",
            "nullable":true,
            "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