Jump to

• Request
• Response

Update a plan review file reviewer

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}

Request

Path Parameters

• DocumentFileKey(required): integer(int64)
  The unique identifier for a plan review file.
• DocumentUserKey(required): integer(int64)
  The unique identifier for a plan review file reviewer.

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

• Decision: string
  Maximum Length: 15

  The decision code for the plan review file reviewer of a plan review cycle. For example, the decision code could be APPROVED.
• OverrideDecision: string
  Maximum Length: 15

  The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user.
• ReviewerDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review is required to be reviewed by the file reviewer user.
• 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":{
        "ReviewerDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review is required to be reviewed by the file reviewer user.",
            "format":"date-time",
            "nullable":true
        },
        "OverrideDecision":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
        },
        "Decision":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision code for the plan review file reviewer of a plan review cycle. For example, the decision code could be APPROVED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : publicSectorPlanReviewFiles-PlanReviewFileUser-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the public sector entity to which this plan review file reviewer applies.
• AssignedBy: integer (int64)
  Read Only: true

  The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator.
• AssignedDttm: string (date-time)
  Read Only: true

  The date when the plan review file reviewer was assigned to the plan review cycle.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the plan review file reviewer record was created.
• Decision: string
  Maximum Length: 15

  The decision code for the plan review file reviewer of a plan review cycle. For example, the decision code could be APPROVED.
• DecisionDttm: string (date-time)
  Read Only: true

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

  Maximum Length: 30

  The unique identifier for a plan reviewer department. This is a user-defined value.
• DocumentFileKey: integer (int64)
  Title: Document File Key

  The unique identifier for a plan review file.
• DocumentUserId: integer (int64)
  Read Only: true

  The unique identifier for a user in the electronic document review application.
• DocumentUserKey: integer (int64)
  The unique identifier for a plan review file reviewer.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address for the plan review file reviewer.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the plan review file reviewer was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Override: string
  Read Only: true

  Maximum Length: 1

  Default Value: N

  Indicates whether the plan review file reviewer decision was overridden. Usually this is done by the plan coordinator user.
• OverrideBy: integer (int64)
  Read Only: true

  The user that entered the override decision. Usually this is the plan coordinator.
• OverrideDecision: string
  Maximum Length: 15

  The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user.
• OverrideDttm: string (date-time)
  Read Only: true

  The date and time that the plan review file reviewer decision was overridden.
• PartyId: integer (int64)
  Read Only: true

  Default Value: 0

  The person party ID for the plan review file reviewer.
• PlanReviewKey: integer (int64)
  Title: Plan Review Key

  The unique identifier for a plan review cycle.
• ReviewerDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review is required to be reviewed by the file reviewer user.
• ReviewerId: integer (int64)
  The unique identifier for a plan review file reviewer user.
• ReviewStatus: string
  Read Only: true

  Maximum Length: 15

  Default Value: INPROGRESS

  The review status code for a plan review file reviewer. For example, the initial review status is INPROGRESS.
• 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 review file 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":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the plan review file reviewer record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideDecision":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review file reviewer applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "OverrideDttm":{
            "type":"string",
            "description":"The date and time that the plan review file reviewer decision was overridden.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The email address for the plan review file reviewer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Decision":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision code for the plan review file reviewer of a plan review cycle. For example, the decision code could be APPROVED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanReviewKey":{
            "title":"Plan Review Key",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReviewerDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review is required to be reviewed by the file reviewer user.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideBy":{
            "type":"integer",
            "description":"The user that entered the override decision. Usually this is the plan coordinator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentUserKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review file reviewer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentFileKey":{
            "title":"Document File Key",
            "type":"integer",
            "description":"The unique identifier for a plan review file.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The person party ID for the plan review file reviewer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DecisionDttm":{
            "type":"string",
            "description":"The date when the decision was updated by the user. The user could be a plan reviewer or a plan coordinator.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerId":{
            "type":"integer",
            "description":"The unique identifier for a plan review file reviewer user.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReviewStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The review status code for a plan review file reviewer. For example, the initial review status is INPROGRESS.",
            "nullable":true,
            "readOnly":true,
            "default":"INPROGRESS",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentUserId":{
            "type":"integer",
            "description":"The unique identifier for a user in the electronic document review application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"11"
            },
            "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
        },
        "AssignedBy":{
            "type":"integer",
            "description":"The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Override":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the plan review file reviewer decision was overridden. Usually this is done by the plan coordinator user.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "UserType":{
            "maxLength":"8",
            "type":"string",
            "description":"The user type for a plan review file 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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the plan review file reviewer was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedDttm":{
            "type":"string",
            "description":"The date when the plan review file reviewer was assigned to the plan review cycle.",
            "format":"date-time",
            "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