Jump to

• Request
• Response

Update a plan review cycle

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}

Request

Path Parameters

• PlanReviewKey(required): integer(int64)
  The unique identifier for a plan review cycle.

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• BluebeamSessions: array Markup Sessions
  Title: Markup Sessions

  Use the markup sessions resource to view, update, create, and delete a markup session.
• Decision: string
  Title: Decision

  Maximum Length: 15

  The decision status for the plan review cycle.
• ElectronicPlanReview: string
  Title: Electronic Review

  Maximum Length: 1

  Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
• FinalizeStatus: string
  Maximum Length: 1

  Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.
• PlanReviewName: string
  Title: Name

  Maximum Length: 100

  The name of the plan review.
• ReviewDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review must be completed.
• ReviewStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: INPROGRESS

  The review status for the plan review cycle.

{
    "type":"object",
    "properties":{
        "BluebeamSessions":{
            "title":"Markup Sessions",
            "type":"array",
            "description":"Use the markup sessions resource to view, update, create, and delete a markup session.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPlanReviews-BluebeamSessions-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "FinalizeStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the status of finalizing the markup session.  Possible values are R, F, and S for Ready, Finalizing, and Success.",
            "nullable":true
        },
        "ReviewStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "nullable":true,
            "default":"INPROGRESS",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanReviewName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":true
        },
        "ReviewDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review must be completed.",
            "format":"date-time",
            "nullable":true
        },
        "ElectronicPlanReview":{
            "title":"Electronic Review",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the plan review has been performed for a document attachment. The default value is N for no.",
            "nullable":true
        },
        "Decision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision status for the plan review cycle.",
            "nullable":true
        }
    }
}

Nested Schema : Markup Sessions

Type: array

Title: Markup Sessions

Use the markup sessions resource to view, update, create, and delete a markup session.

Show Source

• Array of: object schema

{
    "title":"Markup Sessions",
    "type":"array",
    "description":"Use the markup sessions resource to view, update, create, and delete a markup session.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPlanReviews-BluebeamSessions-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• AccessToken: string
  The access token for a markup session.
• 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
  Used for sending multiple files to the electronic document review application.
• SessionFileSource: string
  The unique identifier for the document in the PSCR application.
• 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.
• 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
  Used for registering multiple users to the electronic document review application.

{
    "type":"object",
    "properties":{
        "SessionUserId":{
            "type":"string",
            "description":"The user ID of the markup session user.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionInviteURL":{
            "type":"string",
            "description":"The URL included in an email notification to users to access a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionUsers":{
            "type":"string",
            "description":"Used for registering multiple users to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileSource":{
            "type":"string",
            "description":"The unique identifier for the document in the PSCR application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionEndDate":{
            "title":"Session End Date",
            "type":"string",
            "description":"The ending date for the document review markup session.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileName":{
            "type":"string",
            "description":"The name of the markup session file.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionActivities":{
            "type":"string",
            "description":"Used for sending batch requests to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionAction":{
            "type":"string",
            "description":"The type of action to take within the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionName":{
            "title":"Session Name",
            "type":"string",
            "description":"The name of the markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionUserEmail":{
            "title":"Session User Email",
            "type":"string",
            "description":"The email address of the markup session user.",
            "nullable":true,
            "x-queryable":false
        },
        "AccessToken":{
            "type":"string",
            "description":"The access token for a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileId":{
            "type":"integer",
            "description":"The unique identifier for a markup session file.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionStatus":{
            "title":"Session Status",
            "type":"string",
            "description":"The status of the markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionUserMessage":{
            "title":"Session User Message",
            "type":"string",
            "description":"The message included in an email notification to users to access a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFiles":{
            "type":"string",
            "description":"Used for sending multiple files to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorPlanReviews-item-response

Type: object

Show Source

• AgencyId: integer
  Default Value: 1

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

  The unique identifier for a plan review markup session in the PSCR application.
• BluebeamSessions: array Markup Sessions
  Title: Markup Sessions

  Use the markup sessions resource to view, update, create, and delete a markup session.
• CopyDocuments: string
  The indicator that determines whether to copy the plan review documents from the previous cycle when creating a new plan review cycle.
• CopyReviewer: string
  Default Value: N

  The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle.
• CycleCount: integer (int32)
  Title: Cycle

  The numbering for each plan review cycle.
• CycleDays: integer (int32)
  Title: Cycle Days

  The number of days that the plan review cycle was open or in progress.
• Decision: string
  Title: Decision

  Maximum Length: 15

  The decision status for the plan review cycle.
• ElectronicPlanReview: string
  Title: Electronic Review

  Maximum Length: 1

  Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
• FinalizeStatus: string
  Maximum Length: 1

  Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.
• InviteUrl: string
  Read Only: true

  Maximum Length: 150

  The URL to access the electronic document review application review session.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• OriginalPlanReviewKey: integer (int64)
  Read Only: true

  The plan review key of the initial or original plan review cycle.
• PlanReviewId: string
  Read Only: true

  Maximum Length: 12

  The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.
• PlanReviewKey: integer (int64)
  The unique identifier for a plan review cycle.
• PlanReviewName: string
  Title: Name

  Maximum Length: 100

  The name of the plan review.
• PlanReviewPuid: string
  Maximum Length: 480

  The public unique identifier for a plan review record.
• PlanReviewType: string
  Read Only: true

  Maximum Length: 11

  The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.
• RecordNumber: string
  Maximum Length: 64

  The public unique identifier for a permit record.
• ReviewClosedBy: string
  Maximum Length: 18

  The user who closed the plan review cycle.
• ReviewClosedByPuid: string
  The public unique identifier for the person id that closed the plan review.
• ReviewClosedDttm: string (date-time)
  The date when the plan review cycle was closed.
• ReviewDueDate: string (date-time)
  Title: Due Date

  The date by which the plan review must be completed.
• ReviewOpenBy: string
  Maximum Length: 18

  The user who opened the plan review cycle.
• ReviewOpenByPuid: string
  The public unique identifier for the person id that opened the plan review.
• ReviewOpenDttm: string (date-time)
  Title: Open Date

  The date when the plan review cycle was opened.
• ReviewStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: INPROGRESS

  The review status for the plan review cycle.
• SessionId: string
  Read Only: true

  Maximum Length: 1000

  The unique identifier for a markup session in the electronic document review application.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review cycle applies.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ReviewClosedBy":{
            "maxLength":18,
            "type":"string",
            "description":"The user who closed the plan review cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "ElectronicPlanReview":{
            "title":"Electronic Review",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the plan review has been performed for a document attachment. The default value is N for no.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewOpenBy":{
            "maxLength":18,
            "type":"string",
            "description":"The user who opened the plan review cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "CopyReviewer":{
            "type":"string",
            "description":"The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle.",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "FinalizeStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the status of finalizing the markup session.  Possible values are R, F, and S for Ready, Finalizing, and Success.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "nullable":true,
            "default":"INPROGRESS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanReviewName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginalPlanReviewKey":{
            "type":"integer",
            "description":"The plan review key of the initial or original plan review cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BluebeamSessionKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review markup session in the PSCR application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SessionId":{
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier for a markup session in the electronic document review application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedByPuid":{
            "type":"string",
            "description":"The public unique identifier for the person id that closed the plan review.",
            "nullable":true,
            "x-queryable":true
        },
        "BluebeamSessions":{
            "title":"Markup Sessions",
            "type":"array",
            "description":"Use the markup sessions resource to view, update, create, and delete a markup session.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPlanReviews-BluebeamSessions-item-response"
            },
            "x-cardinality":"1"
        },
        "InviteUrl":{
            "maxLength":150,
            "type":"string",
            "description":"The URL to access the electronic document review application review session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedDttm":{
            "type":"string",
            "description":"The date when the plan review cycle was closed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CopyDocuments":{
            "type":"string",
            "description":"The indicator that determines whether to copy the plan review documents from the previous cycle when creating a new plan review cycle.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CycleDays":{
            "title":"Cycle Days",
            "type":"integer",
            "description":"The number of days that the plan review cycle was open or in progress.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "ReviewDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date by which the plan review must be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PlanReviewType":{
            "maxLength":11,
            "type":"string",
            "description":"The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewOpenByPuid":{
            "type":"string",
            "description":"The public unique identifier for the person id that opened the plan review.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Cycle",
            "type":"integer",
            "description":"The numbering for each plan review cycle.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "Decision":{
            "title":"Decision",
            "maxLength":15,
            "type":"string",
            "description":"The decision status for the plan review cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanReviewPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review record.",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewOpenDttm":{
            "title":"Open Date",
            "type":"string",
            "description":"The date when the plan review cycle was opened.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a permit record.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewId":{
            "maxLength":12,
            "type":"string",
            "description":"The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Markup Sessions

Type: array

Title: Markup Sessions

Use the markup sessions resource to view, update, create, and delete a markup session.

Show Source

• Array of: object publicSectorPlanReviews-BluebeamSessions-item-response

{
    "title":"Markup Sessions",
    "type":"array",
    "description":"Use the markup sessions resource to view, update, create, and delete a markup session.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPlanReviews-BluebeamSessions-item-response"
    },
    "x-cardinality":"1"
}

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 : publicSectorPlanReviews-BluebeamSessions-item-response

Type: object

Show Source

• 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 PSCR 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
  Used for sending multiple files to the electronic document review application.
• SessionFileSource: string
  The unique identifier for the document in the PSCR 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
  Used for registering multiple users to the electronic document review application.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the markup session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the markup session was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionUserId":{
            "type":"string",
            "description":"The user ID of the markup session user.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionInviteURL":{
            "type":"string",
            "description":"The URL included in an email notification to users to access a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionType":{
            "maxLength":15,
            "type":"string",
            "description":"The source of the markup session request. Defaults to PLR for plan review.",
            "nullable":false,
            "default":"PLR",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the markup session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionUsers":{
            "type":"string",
            "description":"Used for registering multiple users to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileSource":{
            "type":"string",
            "description":"The unique identifier for the document in the PSCR application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionEndDate":{
            "title":"Session End Date",
            "type":"string",
            "description":"The ending date for the document review markup session.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileName":{
            "type":"string",
            "description":"The name of the markup session file.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionActivities":{
            "type":"string",
            "description":"Used for sending batch requests to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionAction":{
            "type":"string",
            "description":"The type of action to take within the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionName":{
            "title":"Session Name",
            "type":"string",
            "description":"The name of the markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionUserEmail":{
            "title":"Session User Email",
            "type":"string",
            "description":"The email address of the markup session user.",
            "nullable":true,
            "x-queryable":false
        },
        "AccessToken":{
            "type":"string",
            "description":"The access token for a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionFileId":{
            "type":"integer",
            "description":"The unique identifier for a markup session file.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionStatus":{
            "title":"Session Status",
            "type":"string",
            "description":"The status of the markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BluebeamSessionKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review markup session in the PSCR application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionId":{
            "title":"Session ID",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier for a markup session.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "SessionUserMessage":{
            "title":"Session User Message",
            "type":"string",
            "description":"The message included in an email notification to users to access a markup session.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the markup session was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login for the user who last updated the markup session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionFiles":{
            "type":"string",
            "description":"Used for sending multiple files to the electronic document review application.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Links

BluebeamSessions

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions

Parameters:

• PlanReviewKey: $request.path.PlanReviewKey

Use the markup sessions resource to view, update, create, and delete a markup session.

Back to Top