Jump to

• Request
• Response

Update a markup session

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessions/{BluebeamSessionsUniqID}

Request

Path Parameters

• BluebeamSessionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- BluebeamSessionKey and SessionType ---for the Markup Sessions resource and used to uniquely identify an instance of Markup Sessions. The client should not generate the hash key value. Instead, the client should query on the Markup Sessions collection resource with a filter on the primary key values in order to navigate to a specific instance of Markup Sessions.
  
  For example: BluebeamSessions?q=BluebeamSessionKey=<value1>;SessionType=<value2>
• 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

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

Back to Top