Jump to

• Request
• Response

Update a plan reviewer for a permit plan review

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}

Request

Path Parameters

• PlanReviewUserKey(required): integer(int64)
  The unique identifier for a plan reviewer.

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

• Decision: string
  Title: Decision

  Maximum Length: 15

  The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED.
• OverrideDecision: string
  Title: Override

  Maximum Length: 15

  The decision code when the plan reviewer decision was overridden by the plan coordinator.
• ReviewerDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review must be completed by the reviewer.
• ReviewerId: integer (int64)
  Title: Reviewer

  The unique identifier for a plan reviewer.
• UploadStatus: string
  Maximum Length: 1

  Default Value: N

  The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.

{
    "type":"object",
    "properties":{
        "Decision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideDecision":{
            "title":"Override",
            "maxLength":15,
            "type":"string",
            "description":"The decision code when the plan reviewer decision was overridden by the plan coordinator.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReviewerDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review must be completed by the reviewer.",
            "format":"date-time",
            "nullable":true
        },
        "ReviewerId":{
            "title":"Reviewer",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UploadStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.",
            "nullable":true,
            "default":"N"
        }
    }
}

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 : publicSectorPlanReviewers-item-response

Type: object

Show Source

• AgencyId: integer
  Default Value: 1

  The agency identifier of the public sector entity to which this plan reviewer applies.
• AssignedBy: string
  Maximum Length: 18

  The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator.
• AssignedByPuid: string
  The public unique identifier for the person that assigned the reviewer to the plan review.
• AssignedDttm: string (date-time)
  The date when the plan reviewer was assigned to the plan review cycle.
• Decision: string
  Title: Decision

  Maximum Length: 15

  The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED.
• DecisionDttm: string (date-time)
  Title: Decision Date

  The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The unique identifier for a plan reviewer department. This is a user-defined value.
• DepartmentLeadReviewer: string
  Default Value: N

  The indicator used when creating a new plan reviewer. Used to determine whether the plan reviewers are being added from plan review automatic cycle creation.
• EmailAddress: string
  Maximum Length: 320

  The email address for the plan review file reviewer.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last modified the plan reviewer decision.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Override: string
  Title: Override

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no.
• OverrideBy: string
  Maximum Length: 18

  The user who the entered the override decision. Usually this is the plan coordinator.
• OverrideByPuid: string
  The public unique identifier for the person that provided an override decision for the reviewer.
• OverrideDecision: string
  Title: Override

  Maximum Length: 15

  The decision code when the plan reviewer decision was overridden by the plan coordinator.
• OverrideDttm: string (date-time)
  The date and time when the plan reviewer decision was overridden.
• PartyId: integer (int64)
  Read Only: true

  Default Value: 0

  The person party ID for the plan reviewer.
• PlanReviewKey: integer (int64)
  The unique identifier for a plan review cycle.
• PlanReviewPuid: string
  Maximum Length: 480

  The public unique identifier for a plan review record.
• PlanReviewUserKey: integer (int64)
  The unique identifier for a plan reviewer.
• PlanReviewUserPuid: string
  Maximum Length: 480

  The public unique identifier for a plan reviewer record.
• ReviewerDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review must be completed by the reviewer.
• ReviewerEmailId: integer (int64)
  Read Only: true

  The email address for the plan reviewer.
• ReviewerId: integer (int64)
  Title: Reviewer

  The unique identifier for a plan reviewer.
• ReviewerPuid: string
  The public unique identifier for a plan reviewer.
• ReviewStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: INPROGRESS

  The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS.
• UploadStatus: string
  Maximum Length: 1

  Default Value: N

  The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.
• UserType: string
  Read Only: true

  Maximum Length: 8

  Default Value: I

  The user type for a plan reviewer. For example, I for an internal user and E for an external user. An example of an external user could be a contractor.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer applies.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "AssignedBy":{
            "maxLength":18,
            "type":"string",
            "description":"The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedByPuid":{
            "type":"string",
            "description":"The public unique identifier for the person that assigned the reviewer to the plan review.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedDttm":{
            "type":"string",
            "description":"The date when the plan reviewer was assigned to the plan review cycle.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Decision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DecisionDttm":{
            "title":"Decision Date",
            "type":"string",
            "description":"The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a plan reviewer department. This is a user-defined value.",
            "nullable":false,
            "x-queryable":true
        },
        "DepartmentLeadReviewer":{
            "type":"string",
            "description":"The indicator used when creating a new plan reviewer. Used to determine whether the plan reviewers are being added from plan review automatic cycle creation.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address for the plan review file reviewer.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the plan reviewer decision was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the plan reviewer decision.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Override":{
            "title":"Override",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "OverrideBy":{
            "maxLength":18,
            "type":"string",
            "description":"The user who the entered the override decision. Usually this is the plan coordinator.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideByPuid":{
            "type":"string",
            "description":"The public unique identifier for the person that provided an override decision for the reviewer.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideDecision":{
            "title":"Override",
            "maxLength":15,
            "type":"string",
            "description":"The decision code when the plan reviewer decision was overridden by the plan coordinator.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideDttm":{
            "type":"string",
            "description":"The date and time when the plan reviewer decision was overridden.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The person party ID for the plan reviewer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanReviewPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review record.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewUserKey":{
            "type":"integer",
            "description":"The unique identifier for a plan reviewer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanReviewUserPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan reviewer record.",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS.",
            "nullable":true,
            "default":"INPROGRESS",
            "x-queryable":true
        },
        "ReviewerDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review must be completed by the reviewer.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewerEmailId":{
            "type":"integer",
            "description":"The email address for the plan reviewer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReviewerId":{
            "title":"Reviewer",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReviewerPuid":{
            "type":"string",
            "description":"The public unique identifier for a plan reviewer.",
            "nullable":true,
            "x-queryable":true
        },
        "UploadStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "UserType":{
            "maxLength":8,
            "type":"string",
            "description":"The user type for a plan reviewer. For example, I for an internal user and E for an external user. An example of an external user could be a contractor.",
            "nullable":false,
            "readOnly":true,
            "default":"I",
            "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