Get a plan review document
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments/{DocumentFileKey}
Request
Path Parameters
-
DocumentFileKey: integer
The unique identifier for a plan review document.
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).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPlanReviewDocuments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review document applies.
-
AttachmentId(optional):
integer(int64)
The unique identifier for an attachment file.
-
AttachmentIdCommon(optional):
integer(int64)
The unique identifier for an attachment file.
-
CreationDate(optional):
string(date-time)
The date and time that the plan review document was created.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan review document of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm(optional):
string(date-time)
The date when the decision was updated.
-
Description(optional):
string
Maximum Length:
100
The description of the attachment file. -
DocCategory(optional):
string
Maximum Length:
30
The value that is displayed for the document category related to a plan review document. -
DocGroupId(optional):
string
Maximum Length:
30
The unique identifier for the document group. -
DocSubcategory(optional):
string
Maximum Length:
30
The value that will be displayed for document subcategory related to a plan review document. -
DocumentFileId(optional):
integer(int64)
The unique key associated with the file in the electronic document review application.
-
DocumentFileKey(optional):
integer(int64)
The unique identifier for a plan review document.
-
DocumentReviewedFlag(optional):
string
Maximum Length:
1
The document has been reviewed, marked up, and returned from the electronic document review application. -
FileName(optional):
string
Maximum Length:
255
The name of the attachment file. -
LastUpdateDate(optional):
string(date-time)
The date and time that the plan review document was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the document. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAttachmentKey(optional):
integer(int64)
The unique key associated with the permit attachment file.
-
LnpAttachmentKeyLnp(optional):
integer(int64)
The unique key associated with the permit file attachment.
-
OriginalFileKey(optional):
integer(int64)
The document key of the original or previous version of the document.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
ResubmitStatus(optional):
string
Maximum Length:
1
The status of resubmitting a plan review document for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error. -
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for the plan review document of a plan review cycle. For example, the review status could be INPROGRESS or COMPLETED. -
UploadStatus(optional):
string
Maximum Length:
1
The status of uploading a plan review document for a plan review cycle. Example values are Not Attempted, Success, and Error. -
Version(optional):
integer(int32)
The version of the attachment file.
-
VisibleFlag(optional):
string
Maximum Length:
1
Indicates if the document should be displayed in the user interface.
Nested Schema : link
Type:
Show Source
object
-
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.