Get all plan review documents
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDocuments
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the plan review document that matches the primary key criteria specified.
Finder Variables:- DocumentFileKey; integer; The unique identifier of the plan review document.
- simpleSearchFinder: Finds the plan review document that matches the search criteria specified.
Finder Variables:- keyValue; integer; The key value used to find a specific plan review document.
- value; string; The search value used to find a specific plan review document.
- PrimaryKey: Finds the plan review document that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The agency identifier of the public sector entity to which this plan review document applies.
- AttachmentId; integer; The unique identifier for an attachment file.
- AttachmentIdCommon; integer; The unique identifier for an attachment file.
- CreationDate; string; The date and time when the plan review document was created.
- CreationDateFile; string; The date and time when the plan review file document was created.
- Decision; string; The decision code for the plan review document of a plan review cycle. For example, the decision code could be APPROVED.
- DecisionDttm; string; The date when the decision was updated.
- Description; string; The description of the attachment file.
- DocCategory; string; The value that is displayed for the document category related to a plan review document.
- DocGroupId; string; The unique identifier for the document group.
- DocSubcategory; string; The value that will be displayed for document subcategory related to a plan review document.
- DocumentFileId; integer; The unique key associated with the file in the electronic document review application.
- DocumentFileKey; integer; The unique identifier for a plan review document.
- DocumentReviewedFlag; string; The document has been reviewed, marked up, and returned from the electronic document review application.
- DownloadStatus; string; The status of downloading an attachment file from an electronic plan review cycle session. Example values are N (Not Downloaded), E (Error), and S (Success).
- FileName; string; The name of the attachment file.
- FileSize; integer; The size of the file.
- FileType; string; The type of file.
- LastUpdateDate; string; The date and time when the plan review document was last updated.
- LnpAttachmentKey; integer; The unique key associated with the permit attachment file.
- LnpAttachmentKeyLnp; integer; The unique key associated with the permit file attachment.
- OriginalFileKey; integer; The document key of the original or previous version of the document.
- PlanReviewKey; integer; The unique identifier for a plan review cycle.
- ProtectionLevel; string; Indicates whether the attachment has some level of protection and what type of protection. The default value is N for none.
- ResubmitStatus; string; The status of resubmitting a plan review document for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error.
- ReviewStatus; string; 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; string; The status of uploading an attachment file for a plan review cycle. Example values are N (Not Uploaded), S (Success), E (Error), A (Archived), U (Archived file that had protection removed), P (Encrypted in some way; not Read/Open), and I (Read Protected).
- Version; integer; The version of the attachment file.
- VisibleFlag; string; Indicates if the document should be displayed in the user interface.
- WriteProtectedFlag; string; Indicates whether the document is write-protected.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorPlanReviewDocuments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPlanReviewDocuments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The agency identifier of the public sector entity to which this plan review document applies. -
AttachmentId: integer
(int64)
Read Only:
true
The unique identifier for an attachment file. -
AttachmentIdCommon: integer
(int64)
Read Only:
true
The unique identifier for an attachment file. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the plan review document was created. -
CreationDateFile: string
(date-time)
Read Only:
true
The date and time when the plan review file document was created. -
Decision: string
Title:
Decision
Read Only:true
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: string
(date-time)
Title:
Decision Date
Read Only:true
The date when the decision was updated. -
Description: string
Title:
Description
Read Only:true
Maximum Length:100
The description of the attachment file. -
DocCategory: string
Read Only:
true
Maximum Length:30
The value that is displayed for the document category related to a plan review document. -
DocGroupId: string
Read Only:
true
Maximum Length:30
The unique identifier for the document group. -
DocSubcategory: string
Read Only:
true
Maximum Length:30
The value that will be displayed for document subcategory related to a plan review document. -
DocumentFileId: integer
(int64)
Read Only:
true
The unique key associated with the file in the electronic document review application. -
DocumentFileKey: integer
Read Only:
true
The unique identifier for a plan review document. -
DocumentReviewedFlag: string
Read Only:
true
Maximum Length:1
The document has been reviewed, marked up, and returned from the electronic document review application. -
DownloadStatus: string
Read Only:
true
Maximum Length:1
The status of downloading an attachment file from an electronic plan review cycle session. Example values are N (Not Downloaded), E (Error), and S (Success). -
FileName: string
Title:
File Name
Read Only:true
Maximum Length:255
The name of the attachment file. -
FileSize: integer
(int64)
Read Only:
true
The size of the file. -
FileType: string
Read Only:
true
Maximum Length:100
The type of file. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the plan review document was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpAttachmentKey: integer
(int64)
Read Only:
true
The unique key associated with the permit attachment file. -
LnpAttachmentKeyLnp: integer
(int64)
Read Only:
true
The unique key associated with the permit file attachment. -
OriginalFileKey: integer
(int64)
Read Only:
true
The document key of the original or previous version of the document. -
PlanReviewKey: integer
(int64)
Read Only:
true
The unique identifier for a plan review cycle. -
ProtectionLevel: string
Read Only:
true
Maximum Length:1
Indicates whether the attachment has some level of protection and what type of protection. The default value is N for none. -
ResubmitStatus: string
Read Only:
true
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: string
Title:
Status
Read Only:true
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: string
Read Only:
true
Maximum Length:1
The status of uploading an attachment file for a plan review cycle. Example values are N (Not Uploaded), S (Success), E (Error), A (Archived), U (Archived file that had protection removed), P (Encrypted in some way; not Read/Open), and I (Read Protected). -
Version: integer
(int32)
Read Only:
true
The version of the attachment file. -
VisibleFlag: string
Read Only:
true
Maximum Length:1
Indicates if the document should be displayed in the user interface. -
WriteProtectedFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the document is write-protected.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.