Jump to

• Request
• Response

Update a record type plan reviewer department

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment/{RecordTypePlanReviewerDepartmentUniqID}

Request

Path Parameters

• RecordTypeId(required): string
  The unique identifier for the record type.
• RecordTypePlanReviewerDepartmentUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, RecordTypeId and DepartmentId ---for the Record Type Plan Reviewer Departments resource and used to uniquely identify an instance of Record Type Plan Reviewer Departments. The client should not generate the hash key value. Instead, the client should query on the Record Type Plan Reviewer Departments collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Type Plan Reviewer Departments.
  
  For example: RecordTypePlanReviewerDepartment?q=AgencyId=<value1>;RecordTypeId=<value2>;DepartmentId=<value3>

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

• RequiredFlag: boolean
  Title: Required Department

  Maximum Length: 1

  Indicates whether the department is required to review the documents.
• TimeRuleId: string
  Maximum Length: 50

  The time rule identifier that is used to calculate the due date.

{
    "type":"object",
    "properties":{
        "TimeRuleId":{
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date.",
            "nullable":true
        },
        "RequiredFlag":{
            "title":"Required Department",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the department is required to review the documents.",
            "nullable":true
        }
    }
}

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 : publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the record type plan reviewer departments.
• Department: string
  Read Only: true

  Maximum Length: 25

  The short description of the plan reviewer department identifier.
• DepartmentEnabled: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled.
• DepartmentId: string
  Title: Plan Reviewer Department

  Maximum Length: 30

  The identifier for record type plan reviewer departments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordTypeCode: string
  Maximum Length: 20

  The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.
• RecordTypeId: string
  Maximum Length: 30

  The identifier for the record type associated with the record type plan reviewer departments.
• RequiredFlag: boolean
  Title: Required Department

  Maximum Length: 1

  Indicates whether the department is required to review the documents.
• TimeRuleDescription: string
  Read Only: true

  Maximum Length: 256

  The time rule description.
• TimeRuleId: string
  Maximum Length: 50

  The time rule identifier that is used to calculate the due date.

{
    "type":"object",
    "properties":{
        "Department":{
            "maxLength":"25",
            "type":"string",
            "description":"The short description of the plan reviewer department identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentEnabled":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the record type plan reviewer departments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "TimeRuleId":{
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the record type associated with the record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required Department",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the department is required to review the documents.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Plan Reviewer Department",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "TimeRuleDescription":{
            "maxLength":"256",
            "type":"string",
            "description":"The time rule description.",
            "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