Get all markup sessions
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions
Request
Path Parameters
-
PlanReviewKey(required): integer(int64)
The unique identifier for a plan review cycle.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 markup session that matches the primary key criteria specified.
Finder Variables:- BluebeamSessionKey; integer; The unique identifier of the markup session.
- SessionType; string; The source of the markup session request. Defaults to PLR for plan review.
- PrimaryKey: Finds the markup session 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:- BluebeamSessionKey; integer; The unique identifier for a plan review markup session in the Oracle Permitting and Licensing application.
- CreatedBy; string; The user who created the markup session.
- CreationDate; string; The date and time when the markup session was created.
- LastUpdateDate; string; The date and time when the markup session was last updated.
- LastUpdateLogin; string; The login for the user who last updated the markup session.
- LastUpdatedBy; string; The user who last updated the markup session.
- SessionId; string; The unique identifier for a markup session.
- SessionType; string; The source of the markup session request. Defaults to PLR for plan review.
-
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 : publicSectorPlanReviews-BluebeamSessions
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 : publicSectorPlanReviews-BluebeamSessions-item-response
Type:
Show Source
object
-
AccessToken: string
The access token for a markup session.
-
BluebeamSessionKey: integer
(int64)
Read Only:
true
The unique identifier for a plan review markup session in the Oracle Permitting and Licensing application. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the markup session. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the markup session was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the markup session was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the markup session. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login for the user who last updated the markup session. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SessionAction: string
The type of action to take within the electronic document review application.
-
SessionActivities: string
Used for sending batch requests to the electronic document review application.
-
SessionEndDate: string
(date-time)
Title:
Session End Date
The ending date for the document review markup session. -
SessionFileId: integer
The unique identifier for a markup session file.
-
SessionFileName: string
The name of the markup session file.
-
SessionFiles: string
The list used sending multiple files to the electronic document review application.
-
SessionFileSource: string
The unique identifier for the document in the Oracle Permitting and Licensing application.
-
SessionId: string
Title:
Session ID
Maximum Length:1000
Default Value:0
The unique identifier for a markup session. -
SessionInviteURL: string
The URL included in an email notification to users to access a markup session.
-
SessionName: string
Title:
Session Name
The name of the markup session. -
SessionStatus: string
Title:
Session Status
The status of the markup session. -
SessionType: string
Maximum Length:
15
Default Value:PLR
The source of the markup session request. Defaults to PLR for plan review. -
SessionUserEmail: string
Title:
Session User Email
The email address of the markup session user. -
SessionUserId: string
The user ID of the markup session user.
-
SessionUserMessage: string
Title:
Session User Message
The message included in an email notification to users to access a markup session. -
SessionUsers: string
The list used for registering multiple users to the electronic document review application.
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.