Sdílet prostřednictvím


Content Manager Power Connect (Preview)

Content Manager is a governance-based enterprise content management system designed to help government agencies, regulated industries and global organizations manage their business content from creation to disposal. Connect to Content Manager to perform actions including creating or updating records or locations, uploading or downloading electronic files, searching and more. (1.0.4.757)

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Kapish Services Pty Ltd
URL https://kapish.com.au/products/power_connect/
Email sales@kapish.com.au
Connector Metadata
Publisher Kapish Services Pty Ltd
Website https://kapish.com.au/products/power_connect/
Privacy policy https://kapish.com.au/products/privacy-policy/
Categories Data;Content and Files

The Content Manager Power Connect by Kapish is a connector that provides automation and integration functions into Content Manager to streamline your organisation's ability to meet its information management and governance requirements.

Pre-requisites

  • An externally accessible Content Manager ServiceAPI
  • A subscription key provided by Kapish Services Pty Ltd

For a detailed list of specifications and requirements, or for more information about how the connector can assist your organisation, please contact Kapish Services Pty Ltd

Creating a connection

The connector supports the following authentication types:

OAuth (Confidential Client Flow) Use OAuth to connect to Content Manager All regions Not shareable
System Managed Use a user name and password to connect to Content Manager All regions Not shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. All regions Not shareable

OAuth (Confidential Client Flow)

Auth ID: OAuth

Applicable: All regions

Use OAuth to connect to Content Manager

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
KPC Subscription Key securestring The API key for accessing Kapish Power Connect True
CM ServiceAPI URL (e.g. https://myserver/CMServiceAPI/) string The URL where your CM ServiceAPI can be reached True
Authorization Server URL (e.g. https://myserver/adfs/oauth2/token) string The URL to obtain the access token True
Client ID string The Client ID for authentication True
Client Secret securestring The Client Secret for authentication True

System Managed

Auth ID: Basic

Applicable: All regions

Use a user name and password to connect to Content Manager

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
KPC Subscription Key securestring The API key for accessing Kapish Power Connect True
CM ServiceAPI URL (e.g. https://myserver/CMServiceAPI/) string The URL where your CM ServiceAPI can be reached True
User Name string The user name for authentication True
Password securestring The password for authentication True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
KPC Subscription Key securestring The API key for accessing Kapish Power Connect True
CM ServiceAPI URL (e.g. https://myserver/CMServiceAPI/) string The URL where your CM ServiceAPI can be reached True
Authorization Server URL (e.g. https://myserver/adfs/oauth2/token) string The URL to obtain the access token True
Client ID string The Client ID for authentication True
Client Secret securestring The Client Secret for authentication True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Location (Other)

Create a Location of any type

Create Location (Person)

Create a Person Location

Create Record (Advanced)

Create a Record with Advanced Fields

Create Record (Document)

Create a Record

Create Record (Folder)

Create a Record

Delete Record

Delete a Record

Download Electronic File

Download an Electronic File of a Record

Find CM Objects

Search for CM Objects

Find Location by ID

Fetch a single Location by Unique ID or Name

Find Locations

Search for Locations (Fetch a collection of Locations using a search string)

Find Record by ID

Fetch a single Record by Unique ID or Name

Find Records

Search for Records (Fetch a collection of Records using a search string)

Find Records (Advanced)

Search for Records (Fetch a collection of Records using a search string). Returns a raw Content Manager ServiceAPI response.

Find Unique ID of Location Address

Get the Unique ID of a Location's Child Address

Get File from URL

Download a file from URL to a staging area using the 'GetFileFromUrl' CM Service API plugin

Read Event Data

Transform Kapish Dispatch event data for flow consumption

Update Location (Additional Fields)

Update Additional Fields on a Location

Update Location (Address)

Create / Update a Location's Address using the Unique ID of the address

Update Location (Other)

Update a Location

Update Location (Person)

Update a Person Location using its Unique Identifier

Update Record (Add Access Controls)

AddAccessControl

Update Record (Additional Fields)

Update Additional Fields on a Record

Update Record (Advanced)

Update a Record with Advanced Properties

Update Record (Attach Action or Procedure)

Attach an Action or procedure to a Record

Update Record (Attach Contact)

Attach a Contact to a Record

Update Record (Attach Electronic File)

Attach an Electronic File to a Record

Update Record (Attach Thesaurus Term)

Attach a Thesaurus Term to a Record

Update Record (Checkout)

Set the status of the Record to checked out

Update Record (Classification)

Update the Classification of a Record

Update Record (Close)

Use the CloseRecord function to close a container - leave the date blank if you want the close date to be 'now'. Because closing a record may require updating many contained records, this function commits the changes automatically

Update Record (Complete Actions)

Complete one or all actions due on a particular Record

Update Record (Dispose)

Dispose of a Record

Update Record (Finalise)

Update a draft Record

Update Record (Properties)

Update a Record

Update Record (Reassign Action)

Reassigns the nominated action to a specified location

Update Record (Remove All Actions)

Removes all actions attached to the specified record

Update Record (Remove Location from Access Controls)

RemoveAccessControl

Update Record (Reopen)

Use the ReopenRecord function to re-open a closed container. Because re-opening a record may require updating many contained records, this function commits the changes automatically

Update Record (Replace Access Controls)

SetAccessControl

Update Record (Request Rendition)

Allows you to create a request for the automatic rendering engine to make a rendition of a record

Update Record (Reschedule Actions)

Reschedules all actions attached to this record

Update Record (Set Access Unrestricted or Based on Container)

InheritAccessControl

Update Record (Set Assignee)

Set the Assignee to a particular Location, back to Home or register as Missing

Update Record (Set User Label)

Allows for the setting of a user label on a Record

Update Record (Undispose)

Reverts the state of the record (and any of its contents) so that it is no longer disposed

Update Record (Undo Checkout)

Undo a previous checkout of the electronic document for this Record, disregarding any changes made since it was checked out

Update Record (Unfinalise - Set As Draft)

Update a Finalised Record to Draft

Upload Electronic File

Upload an Electronic File which may later be attached to a Record

Create Location (Other)

Create a Location of any type

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Location Type
LocationTypeOfLocation string
Name
LocationSortName True string
Unique Name
LocationNickName string
ID Number
LocationIdNumber string
Internal
LocationIsWithin boolean
Business Phone
LocationPhoneNumber string
Mobile Phone
LocationMobileNumber string
Fax
LocationFaxNumber string
Home Phone
LocationAfterHoursPhoneNumber string
Same As Address
LocationUseAddressOf integer

Unique ID of Location

Address Type
LocationAddressAddressType string

Select address type. Limit of one per type.

Street
LocationAddressAddressLines string
Suburb / City
LocationAddressCity string
State
LocationAddressState string
Postcode
LocationAddressPostcode string
Country
LocationAddressCountry string
Make Default
AddRelationshipMakeThisTheDefaultRelationship boolean
Related Unique ID
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Email Address
LocationEmailAddress string
From
SetActiveDateRangeValidFromDate string

dd/mm/yyyy

To
SetActiveDateRangeValidToDate string

dd/mm/yyyy

Notes
LocationNotes string
Notes Update Type
NotesUpdateType string

Returns

Create Location (Person)

Create a Person Location

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Title
LocationHonorific string
Last Name
LocationSurname string
First Name
LocationGivenNames string
Internal
LocationIsWithin boolean
Job Title
LocationJobDescription string
Date of Birth
LocationDateOfBirth string
Salutation
LocationSalutation string
Unique Name
LocationNickName string
ID Number
LocationIdNumber string
Business Phone
LocationPhoneNumber string
Mobile Phone
LocationMobileNumber string
Fax
LocationFaxNumber string
Home Phone
LocationAfterHoursPhoneNumber string
Same As Address
LocationUseAddressOf integer

Unique ID of Location

Address Type
LocationAddressAddressType string

Select address type. Limit of one per type.

Street
LocationAddressAddressLines string
Suburb / City
LocationAddressCity string
State
LocationAddressState string
Postcode
LocationAddressPostcode string
Country
LocationAddressCountry string
Make Default
AddRelationshipMakeThisTheDefaultRelationship boolean
Related Unique ID
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Email Address
LocationEmailAddress string
Gender
LocationGenderValue string
Accepting Logins
LocationCanLogin boolean
Network Login
LocationLogsInAs string
Additional Network Login
LocationAdditionalLogin string
Login Expires On
LocationLoginExpires string
User Profile Of
LocationUseProfileOf integer

Unique ID of Location

User Type
LocationUserType string
Security String
LocationSecurityString string
From
SetActiveDateRangeValidFromDate string

dd/mm/yyyy

To
SetActiveDateRangeValidToDate string

dd/mm/yyyy

Notes
LocationNotes string
Notes Update Type
NotesUpdateType string

Returns

Create Record (Advanced)

Create a Record with Advanced Fields

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Record Type
RecordRecordType True string
Title (Free Text Part)
RecordTypedTitle True string
Classification
RecordClassification string

Provide the Unique Identifier of the Classification

Author
RecordAuthor string

Unique ID or email address of Location

Properties
Properties string

A comma delimited list of properties to return

Accession Number
RecordAccessionNumber string
Addressee
RecordAddressee string

Unique ID or email address of Location

Alternative Container
RecordAlternativeContainer string
Assignee
RecordAssignee string

Unique ID or email address of Location

Auto Classification Confidence Level
RecordAutoClassificationConfidenceLevel string
Auto Render to PDF On Save
RecordAutoRenderToPDFOnSave boolean
Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Bypass Save?
ByPassSave boolean

True to not save the object. One use of this is to set one or more properties on a Record post and return the data entry form. The data entry form will then reflect the various properties set on the original Record.

Change Position Within Favourites
ChangePositionWithinFavorites string

When search for favorites they will be returned in this order unless another sort is used.

Change Position Within User Label
ChangePositionWithinUserLabel string

When searching by UserLabel they wil be returned in this order unless another sort is used.,

Check In As
CheckinAs string

Set the Source property of the electronic document.

Class of Record
RecordClassOfRecord string
Client
RecordClient string

Unique ID or email address of Location

Client Record
RecordClientRecord string
Comments
comments string

Comments to go in the Record Notes when the document is uploaded.

Consignment
RecordConsignment string
Consignment Object
RecordConsignmentObject string
Container
RecordContainer string
Copy Document From Record
CopyDocumentFromRecord string

Specify a Unique ID for the Record from which to copy the electronic document for this Record.,

Creator
RecordCreator string

Unique ID or email address of Location

Date Created
RecordDateCreated string
Date Due
RecordDateDue string
Date Published
RecordDatePublished string
Date Received
RecordDateReceived string
Editor
RecordEditor string

Unique ID or email address of Location

External Reference
RecordExternalReference string
Fail On Warnings?
FailOnWarnings boolean

True to not create/save an object if there are any warnings.

File Name in Uploads folder
RecordFilePath string

The filename as it appears in the Uploads folder.

Finalize on Save
RecordFinalizeOnSave boolean
Foreign Barcode
RecordForeignBarcode string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation string

Unique ID of Location

Home Space
RecordHomeSpace string
Initiate Template
RecordInitiateTemplate string
Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Keep Checked Out
keepBookedOut boolean

True to leave the Record checked out after the electronic document is uploaded.

Last Action Date
RecordLastActionDate string
Long Number
RecordLongNumber string
Make Active
MakeActive string

Reverts the state of the record (and any of its contents) so that it is no longer inactive. When processing contents you can specify whether the task should halt if any failures occur.

Make Inactive
MakeInactive string

Sets the dateInactive for this record and any of its contents. When processing contents you can specify whether the task should halt if any failures occur.

Make New Revision
makeNewRevision boolean

True to create a new Revision with this Electronic document false to replace the current Revision.

Manual Destruction Date
RecordManualDestructionDate string
Matter Record
RecordMatterRecord string
Media Type
RecordMediaType string
My Authorization Comments
RecordMyAuthorizationComments string
My Authorization Complete
RecordMyAuthorizationComplete boolean
My Review Comments
RecordMyReviewComments string
My Review Complete
RecordMyReviewComplete boolean
Needs Authorization?
RecordNeedsAuthorization boolean
Needs Review?
RecordNeedsReview boolean
New Part Creation Rule
RecordNewPartCreationRule string

Unique ID of Auto Part Creation Rule

Notes
RecordNotes string
Notes Update Type
NotesUpdateType string
Other Contact
RecordOtherContact string

Unique ID or email address of Location

Owner Location
RecordOwnerLocation string

Unique ID or email address of Location

Preserver Hierarchy On Data Entry?
RecordPreserveHierarchyOnDataEntry boolean
Previous Part Record
RecordPrevPartRecord string
Priority
RecordPriority string
Record New Type
RecordNewType string

Leave as Default unless creating a New Part Version or Copy.

Related Record
RecordRelatedRecord string
Representative
RecordRepresentative string
Retention Schedule
RecordRetentionSchedule string
Review Date
RecordReviewDate string
Review Due Date
RecordReviewDueDate string
Review State
RecordReviewState string
Security
RecordSecurity string
Series Record
RecordSeriesRecord string
Property Sets
propertySets string

Specify Property Sets in addition to those posted to be returned by the request.

Query String
q string

Specify a query here to apply the update to a set of Records rather than only one (as specified by the Unique ID).

Returns

Create Record (Document)

Create a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Record Type
RecordRecordType True string
Title (Free Text Part)
RecordTypedTitle True string
Properties
Properties string

A comma delimited list of properties to return

Author
RecordAuthor string

Unique ID or email address of Location

Addressee
RecordAddressee string

Unique ID or email address of Location

Alternative Container
RecordAlternativeContainer string
Assignee
RecordAssignee string

Unique ID or email address of Location

Auto Render to PDF On Save
RecordAutoRenderToPDFOnSave boolean
Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Check In As
CheckinAs string

Set the Source property of the electronic document.

Classification
RecordClassification string

Provide the Unique Identifier of the Classification

Client
RecordClient string

Unique ID or email address of Location

Client Record
RecordClientRecord string
Container
RecordContainer string
Copy Document From Record
CopyDocumentFromRecord string

Specify a Unique ID for the Record from which to copy the electronic document for this Record.,

Creator
RecordCreator string

Unique ID or email address of Location

Date Created
RecordDateCreated string
Date Due
RecordDateDue string
Date Published
RecordDatePublished string
Date Received
RecordDateReceived string
External Reference
RecordExternalReference string
Fail On Warnings?
FailOnWarnings boolean

True to not create/save an object if there are any warnings.

File Name in Uploads folder
RecordFilePath string

The filename as it appears in the Uploads folder.

Finalize on Save
RecordFinalizeOnSave boolean
Foreign Barcode
RecordForeignBarcode string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation string

Unique ID of Location

Home Space
RecordHomeSpace string
Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Keep Checked Out
keepBookedOut boolean

True to leave the Record checked out after the electronic document is uploaded.

Last Action Date
RecordLastActionDate string
Long Number
RecordLongNumber string
Media Type
RecordMediaType string
Notes
RecordNotes string
Notes Update Type
NotesUpdateType string
Other Contact
RecordOtherContact string

Unique ID or email address of Location

Owner Location
RecordOwnerLocation string

Unique ID or email address of Location

Related Record
RecordRelatedRecord string
Representative
RecordRepresentative string

Unique ID or email address of Location

Review Date
RecordReviewDate string
Review Due Date
RecordReviewDueDate string
Review State
RecordReviewState string
Security
RecordSecurity string

Returns

Create Record (Folder)

Create a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Record Type
RecordRecordType True string
Title (Free Text Part)
RecordTypedTitle True string
Classification
RecordClassification string

Provide the Unique Identifier of the Classification

Container
RecordContainer string
Properties
Properties string

A comma delimited list of properties to return

Author
RecordAuthor string

Unique ID or email address of Location

Addressee
RecordAddressee string

Unique ID or email address of Location

Alternative Container
RecordAlternativeContainer string
Assignee
RecordAssignee string

Unique ID or email address of Location

Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Client
RecordClient string

Unique ID or email address of Location

Creator
RecordCreator string

Unique ID or email address of Location

Date Created
RecordDateCreated string
Date Due
RecordDateDue string
Date Published
RecordDatePublished string
External Reference
RecordExternalReference string
Fail On Warnings?
FailOnWarnings boolean

True to not create/save an object if there are any warnings.

File Name in Uploads folder
RecordFilePath string

The filename as it appears in the Uploads folder.

Foreign Barcode
RecordForeignBarcode string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation string

Unique ID of Location

Home Space
RecordHomeSpace string
Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Last Action Date
RecordLastActionDate string
Long Number
RecordLongNumber string
Notes
RecordNotes string
Notes Update Type
NotesUpdateType string
Other Contact
RecordOtherContact string

Unique ID or email address of Location

Owner Location
RecordOwnerLocation string

Unique ID or email address of Location

Related Record
RecordRelatedRecord string
Representative
RecordRepresentative string

Unique ID or email address of Location

Review Date
RecordReviewDate string
Review Due Date
RecordReviewDueDate string
Review State
RecordReviewState string
Security
RecordSecurity string

Returns

Delete Record

Delete a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer

The Unique ID of the Record to be deleted

Delete Contents?
DeleteContents True boolean
New Home for Contents
NewHomeForContents string

The Unique ID or email address of new Home Location for the contents

Returns

Download Electronic File

Download an Electronic File of a Record

Parameters

Name Key Required Type Description
Unique Identifier
uri True string

Unique ID or Record number

User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Returns

response
binary

Find CM Objects

Search for CM Objects

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Search for
TrimType True string
Query String
q True string

Enter a search query, e.g. 'all' to get all objects.

Apply Defaults
ApplyDefaults boolean

True to apply the user's default filter and sort to this search.

Count Results
CountResults boolean

CountResults returns the most reliable and the slowest count of the total search results. The resulting count is in the response Count property.

Descendant Properties
DescendantProperties string

A comma separated list of object properties, applies only to object properties of this and lower level properties e.g. RecordNumber,RecordTitle.

Exclude Count
ExcludeCount boolean

Returning the TotalResults and SearchTitle can degrade performance. Set to true if TotalResults and SearchTitle are not required.

Filter
Filter string

A space separated list of search clauses to apply as a filter.

From Search
FromSearch integer

The Unique ID of a Saved Search from which to construct this search.

Include Property Defs
IncludePropertyDefs boolean

True to return an array of the Property Definitions used by properties in this response.

Options
Options string

Set one or more of the options typically set in User Options for this search only. Use ids from the /PropertyDef?Get=SearchOptions service, append a minus sign to set to false, otherwise true is assumed.

Page Size
pageSize integer

The number of items to return in each page of results. If empty, defaults to default value set in configuration.

Property Value
PropertyValue string

Include the raw value, the string value, or both in the results.

Property Sets
PropertySets string

One or more pre-defined property sets, select from DataGridVisible, Detailed, FromSearch, All or a custom property set as defined in your service configuration.

Purpose
purpose integer

A special property to filter search results based on object Purpose enum values.

Purpose Extra
purposeExtra integer

Necessary as a supplement to some purposes. The ObjectDef service provides information on the enum or TrimMainObject type to specify, in particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes and HaveExtraPurposeParameter.

Sort By
sortBy string

A comma separated list of search clause Ids. Use - to specify descending. E.g. Number- to sort Records by number descending.

Start
start integer

The position in the result set to start, empty (or 1) to start at the beginning, 2 to start at the second object, 3 at the third, etc.

StringDisplayType
StringDisplayType string

If returning the string value which format to use.

Properties
properties string

A comma separated list of object properties, e.g. Uri,NameString

Returns

Find Location by ID

Fetch a single Location by Unique ID or Name

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Id True string

Either the object Unique ID or Name

Descendant Properties
descendantProperties string

A comma separated list of object properties, applies only to object properties of this and lower level properties e.g. Surname,GivenNames

Include Property Definitions
IncludePropertyDefs boolean

True to return an array of the Property Definitions used by properties in this response

Properties
properties string

A comma separated list of object properties, e.g. Surname,GivenNames

Property Sets
propertySets string

One or more pre-defined property sets, select from DataGridVisible, Detailed, FromSearch, All or a custom property set as defined in your service configuration

Property Value
PropertyValue string

Include the raw value, the string value, or both in the results

String Display Type
stringDisplayType string

Returns the string value which format to use

Returns

Find Locations

Search for Locations (Fetch a collection of Locations using a search string)

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Query
q True string

Enter a search query, e.g. 'all' to get all objects.

Apply Defaults
ApplyDefaults boolean

True to apply the user's default filter and sort to this search

Count Results
CountResults boolean

True to include a count of the results

Exclude Count
ExcludeCount boolean

True to exclude a count of the results

Filter
filter string

A space separated list of search clauses to apply as a filter.

From Search
fromSearch string

The Unique ID of a Saved Search from which to construct this search

Descendant Properties
descendantProperties string

A comma separated list of object properties, applies only to object properties of this and lower level properties e.g. RecordNumber,RecordTitle

Include Property Definitions
IncludePropertyDefs boolean

True to return an array of the Property Definitions used by properties in this response

Options
Options string

Set one or more of the options typically set in User Options for this search only. Use ids from the /PropertyDef?Get=SearchOptions service, append a minus sign to set to false, otherwise true is assumed.

Properties
properties string

A comma separated list of object properties, e.g. RecordNumber,RecordTitle

Property Sets
propertySets string

One or more pre-defined property sets, select from DataGridVisible, Detailed, FromSearch, All or a custom property set as defined in your service configuration

Property Value
PropertyValue string

Include the raw value, the string value, or both in the results

Page Size
pageSize string

The number of items to return in each page of results

Purpose
purpose string

A special property to filter search results based on object Purpose enum values

Purpose Extra
purposeExtra string

Necessary as a supplement to some purposes. The ObjectDef service provides information on the enum or TrimMainObject type to specify, in particular ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes and HaveExtraPurposeParameter.

Sort By
sortBy string

A comma separated list of search clause Ids

Start
start string

The position in the result set to start, empty (or 1) to start at the beginning, 2 to start at the second object, 3 at the third, etc

String Display Type
stringDisplayType string

If returning the string value which format to use

Returns

Find Record by ID

Fetch a single Record by Unique ID or Name

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

ID
Id True string

Either the object Unique ID or Name

Include Property Definitions
IncludePropertyDefs boolean

True to return an array of the Property Definitions used by properties in this response

Descendant Properties
descendantProperties string

A comma separated list of object properties, applies only to object properties of this and lower level properties e.g. RecordNumber,RecordTitle.

Properties
properties string

A comma separated list of object properties, e.g. RecordNumber,RecordTitle.

Property Sets
propertySets string

One or more pre-defined property sets, select from DataGridVisible, Detailed, FromSearch, All or a custom property set as defined in your service configuration.

Property Value
PropertyValue string

Include the raw value, the string value, or both in the results

String Display Type
stringDisplayType string

If returning the string value which format to use

Returns

Find Records

Search for Records (Fetch a collection of Records using a search string)

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Query
q True string

Search query

Properties
properties True string

A comma separated list of properties to return

Returns

Find Records (Advanced)

Search for Records (Fetch a collection of Records using a search string). Returns a raw Content Manager ServiceAPI response.

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Query
q True string

Search query

Properties
properties True string

A comma separated list of properties to return

Returns

response
object

Find Unique ID of Location Address

Get the Unique ID of a Location's Child Address

Parameters

Name Key Required Type Description
Type
type string

Select address type

Unique Identifier
LocationUri True string

Unique ID of Location

User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Returns

Child Address
CMLocationAddressUri

Get File from URL

Download a file from URL to a staging area using the 'GetFileFromUrl' CM Service API plugin

Parameters

Name Key Required Type Description
URL of File
url True string

Unencoded URL of the file to download

Filename to Save As
filename string

Filename to save the downloaded URL as (just the filename with suffix, do not include the full directory)

Content Type
contentType string

Typical string found in most Content-Type header (e.g. image/png, text/plain, application/pdf).

Returns

Response from the 'GetFileFromUrl' CM Service API plugin.

Read Event Data

Transform Kapish Dispatch event data for flow consumption

Parameters

Name Key Required Type Description
Content
Content string

The content of the Service Bus action that retrieved the CM Event Data

Returns

Update Location (Additional Fields)

Update Additional Fields on a Location

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri integer
Name
SearchClause string
Value
Value string

Returns

Update Location (Address)

Create / Update a Location's Address using the Unique ID of the address

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer

The uri of the existing location to be updated

Unique ID
Uri integer

The uri of the existing street or mailing address to be updated

Type
LocationAddressAddressType string

Select address type. Limit of one per type.

Street
LocationAddressAddressLines string
Suburb / City
LocationAddressCity string
State
LocationAddressState string
Postcode
LocationAddressPostcode string
Country
LocationAddressCountry string

Returns

Update Location (Other)

Update a Location

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri integer
Query String
q string

Specify a query here to apply the update to a set of Locations rather than only one (as specified by the Unique ID).

Name
LocationSortName string
Unique Name
LocationNickName string
ID Number
LocationIdNumber string
Business Phone
LocationPhoneNumber string
Mobile Phone
LocationMobileNumber string
Fax
LocationFaxNumber string
Home Phone
LocationAfterHoursPhoneNumber string
Same As Address
LocationUseAddressOf integer

Unique ID of Location

Make Default
AddRelationshipMakeThisTheDefaultRelationship boolean
Related Unique ID
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Email Address
LocationEmailAddress string
From
SetActiveDateRangeValidFromDate string

dd/mm/yyyy

To
SetActiveDateRangeValidToDate string

dd/mm/yyyy

Notes
LocationNotes string
Notes Update Type
NotesUpdateType string
Related Unique ID
RemoveRelationshipRelatedLocation integer

Returns

Update Location (Person)

Update a Person Location using its Unique Identifier

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri integer
Query String
q string

Specify a query here to apply the update to a set of Locations rather than only one (as specified by the Unique ID).

Title
LocationHonorific string
Last Name
LocationSurname string
First Name
LocationGivenNames string
Internal
LocationIsWithin boolean
Job Title
LocationJobDescription string
Date of Birth
LocationDateOfBirth string
Salutation
LocationSalutation string
Unique Name
LocationNickName string
ID Number
LocationIdNumber string
Business Phone
LocationPhoneNumber string
Mobile Phone
LocationMobileNumber string
Fax
LocationFaxNumber string
Home Phone
LocationAfterHoursPhoneNumber string
Same As Address
LocationUseAddressOf integer

Unique ID of Location

Make Default
AddRelationshipMakeThisTheDefaultRelationship boolean
Related Unique ID
AddRelationshipRelatedLocation integer
Type
AddRelationshipRelationshipType string
Email Address
LocationEmailAddress string
Gender
LocationGenderValue string
Accepting Logins
LocationCanLogin boolean
Network Login
LocationLogsInAs string
Additional Network Login
LocationAdditionalLogin string
Login Expires On
LocationLoginExpires string
User Profile Of
LocationUseProfileOf integer

Unique ID of Location

User Type
LocationUserType string
Security String
LocationSecurityString string
From
SetActiveDateRangeValidFromDate string

dd/mm/yyyy

To
SetActiveDateRangeValidToDate string

dd/mm/yyyy

Notes
LocationNotes string
Notes Update Type
NotesUpdateType string
Related Unique ID
RemoveRelationshipRelatedLocation integer

Returns

Update Record (Add Access Controls)

AddAccessControl

Parameters

Name Key Required Type Description
Unique Identifier
Uri True integer
FunctionEnum
FunctionEnum string
Unique ID
Uri integer

Location Unique Identifier

Returns

Update Record (Additional Fields)

Update Additional Fields on a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri integer
Name
SearchClause string
Value
Value string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Advanced)

Update a Record with Advanced Properties

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Record Type
RecordRecordType string
Classification
RecordClassification string

Provide the Unique Identifier of the Classification

Properties
Properties string

A comma delimited list of properties to return

Author
RecordAuthor string

Unique ID or email address of Location

Accession Number
RecordAccessionNumber string
Addressee
RecordAddressee string

Unique ID or email address of Location

Alternative Container
RecordAlternativeContainer string
Assignee
RecordAssignee string

Unique ID or email address of Location

Auto Classification Confidence Level
RecordAutoClassificationConfidenceLevel string
Auto Render to PDF On Save
RecordAutoRenderToPDFOnSave boolean
Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Bypass Save?
ByPassSave boolean

True to not save the object. One use of this is to set one or more properties on a Record post and return the data entry form. The data entry form will then reflect the various properties set on the original Record.

Change Position Within Favourites
ChangePositionWithinFavorites string

When search for favorites they will be returned in this order unless another sort is used.

Change Position Within User Label
ChangePositionWithinUserLabel string

When searching by UserLabel they wil be returned in this order unless another sort is used.,

Check In As
CheckinAs string

Set the Source property of the electronic document.

Class of Record
RecordClassOfRecord string
Client
RecordClient string

Unique ID or email address of Location

Client Record
RecordClientRecord string
Comments
comments string

Comments to go in the Record Notes when the document is uploaded.

Consignment
RecordConsignment string
Consignment Object
RecordConsignmentObject string
Container
RecordContainer string
Copy Document From Record
CopyDocumentFromRecord string

Specify a Unique ID for the Record from which to copy the electronic document for this Record.,

Creator
RecordCreator string

Unique ID or email address of Location

Date Created
RecordDateCreated string
Date Due
RecordDateDue string
Date Published
RecordDatePublished string
Date Received
RecordDateReceived string
Editor
RecordEditor string

Unique ID or email address of Location

Electronic Document Store
RecordEStore string
External Reference
RecordExternalReference string
Fail On Warnings?
FailOnWarnings boolean

True to not create/save an object if there are any warnings.

File Name in Uploads folder
RecordFilePath string

The filename as it appears in the Uploads folder.

Finalize on Save
RecordFinalizeOnSave boolean
Foreign Barcode
RecordForeignBarcode string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation string

Unique ID of Location

Home Space
RecordHomeSpace string
Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Keep Checked Out
keepBookedOut boolean

True to leave the Record checked out after the electronic document is uploaded.

Last Action Date
RecordLastActionDate string
Long Number
RecordLongNumber string
Make Active
MakeActive string

Reverts the state of the record (and any of its contents) so that it is no longer inactive. When processing contents you can specify whether the task should halt if any failures occur.

Make Inactive
MakeInactive string

Sets the dateInactive for this record and any of its contents. When processing contents you can specify whether the task should halt if any failures occur.

Make New Revision
makeNewRevision boolean

True to create a new Revision with this Electronic document false to replace the current Revision.

Manual Destruction Date
RecordManualDestructionDate string
Matter Record
RecordMatterRecord string
Media Type
RecordMediaType string
My Authorization Comments
RecordMyAuthorizationComments string
My Authorization Complete
RecordMyAuthorizationComplete boolean
My Review Comments
RecordMyReviewComments string
My Review Complete
RecordMyReviewComplete boolean
Needs Authorization?
RecordNeedsAuthorization boolean
Needs Review?
RecordNeedsReview boolean
New Part Creation Rule
RecordNewPartCreationRule string

Unique ID of Auto Part Creation Rule

Notes
RecordNotes string
Notes Update Type
NotesUpdateType string
Other Contact
RecordOtherContact string

Unique ID or email address of Location

Owner Location
RecordOwnerLocation string

Unique ID or email address of Location

Preserver Hierarchy On Data Entry?
RecordPreserveHierarchyOnDataEntry boolean
Previous Part Record
RecordPrevPartRecord string
Priority
RecordPriority string
Record New Type
RecordNewType string

Leave as Default unless creating a New Part Version or Copy.

Related Record
RecordRelatedRecord string
Representative
RecordRepresentative string
Retention Schedule
RecordRetentionSchedule string
Review Date
RecordReviewDate string
Review Due Date
RecordReviewDueDate string
Review State
RecordReviewState string
Security
RecordSecurity string
Series Record
RecordSeriesRecord string
Title (Free Text Part)
RecordTypedTitle string
Query String
q string

Specify a query here to apply the update to a set of Records rather than only one (as specified by the Unique ID).

Returns

Update Record (Attach Action or Procedure)

Attach an Action or procedure to a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Action To Attach
ActionToAttach True integer
Assignee Unique ID
NewAssignee integer
Assignee Option
AssigneeOption string
Schedule Start Date
ScheduleStartDate date
Existing Action
RecordAction integer
Insert Position
InsertPos string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Attach Contact)

Attach a Contact to a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Contact Type
ContactType True string
Contact Location
ContactLocation True string

Unique ID or email address of Location

Set as primary contact?
IsPrimary True boolean
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Attach Electronic File)

Attach an Electronic File to a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

File
File True file

The File Content/Body of the electronic document to attach

Unique Identifier
Uri True string

Unique ID of the record

Returns

Update Record (Attach Thesaurus Term)

Attach a Thesaurus Term to a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Record
Uri True integer

The Unique ID of the Record to attach the Thesaurus Term to

Thesaurus Term
Keyword True string

The Unique ID or Name of the Thesaurus Term to attach

Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Checkout)

Set the status of the Record to checked out

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Comments
Comments string
Save Checkout Path As
SaveCheckoutPathAs string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Classification)

Update the Classification of a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Classification
RecordClassification True string

Provide the Unique Identifier of the Classification

Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Close)

Use the CloseRecord function to close a container - leave the date blank if you want the close date to be 'now'. Because closing a record may require updating many contained records, this function commits the changes automatically

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Continue on Error?
ContinueOnError boolean
Enclose Contents?
EncloseContents boolean
Finalize Contents?
FinalizeContents boolean
Log Errors Only?
LogErrorsOnly boolean
Log Results?
LogResults boolean

Return a text log of the Records closed in the Log Message property?

Purge Content Revisions?
PurgeContentRevisions boolean
Specific Close Date?
SpecificCloseDate date
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Complete Actions)

Complete one or all actions due on a particular Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Complete
Complete True string

Specify which Record Actions to complete

Complete Previous Actions
CompletePrevious boolean

Complete all Record Actions prior to the one specified

Completion Date
CompletionDate date

The date to set as the completion date

Record Action Unique ID
RecordActionUri integer

The Unique ID of the Record Action to complete if 'For Unique Identifier' is selected

Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Dispose)

Dispose of a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Continue on error?
ContinueOnError boolean
Method of disposal
MethodOfDisposal string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Finalise)

Update a draft Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Remove Old Revisions
SetAsFinalRemoveOldRevisions boolean
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Properties)

Update a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri integer
Query
q string

Specify a query here to apply the update to a set of Records rather than only one (as specified by the Unique ID)

Title (Free Text Part)
RecordTypedTitle string
Properties
Properties string

A comma delimited list of properties to return

Author
RecordAuthor string

Unique ID or email address of Location

Container
RecordContainer string
Classification
RecordClassification string

Provide the Unique Identifier of the Classification

Addressee
RecordAddressee string

Unique ID or email address of Location

Alternative Container
RecordAlternativeContainer string
Assignee
RecordAssignee string

Unique ID or email address of Location

Auto Render to PDF On Save
RecordAutoRenderToPDFOnSave boolean
Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Check In As
CheckinAs string

Set the Source property of the electronic document.

Client
RecordClient string

Unique ID or email address of Location

Client Record
RecordClientRecord string
Copy Document From Record
CopyDocumentFromRecord string

Specify a Unique ID for the Record from which to copy the electronic document for this Record.,

Creator
RecordCreator string

Unique ID or email address of Location

Date Created
RecordDateCreated string
Date Due
RecordDateDue string
Date Published
RecordDatePublished string
Date Received
RecordDateReceived string
External Reference
RecordExternalReference string
Fail On Warnings?
FailOnWarnings boolean

True to not create/save an object if there are any warnings.

File Name in Uploads folder
RecordFilePath string

The filename as it appears in the Uploads folder.

Finalize on Save
RecordFinalizeOnSave boolean
Foreign Barcode
RecordForeignBarcode string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation string

Unique ID of Location

Home Space
RecordHomeSpace string
Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Keep Checked Out
keepBookedOut boolean

True to leave the Record checked out after the electronic document is uploaded.

Long Number
RecordLongNumber string
Media Type
RecordMediaType string
Notes
RecordNotes string
Notes Update Type
NotesUpdateType string
Other Contact
RecordOtherContact string

Unique ID or email address of Location

Owner Location
RecordOwnerLocation string

Unique ID or email address of Location

Related Record
RecordRelatedRecord string
Representative
RecordRepresentative string
Review Date
RecordReviewDate string
Review Due Date
RecordReviewDueDate string
Review State
RecordReviewState string
Security
RecordSecurity string

Returns

Update Record (Reassign Action)

Reassigns the nominated action to a specified location

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
New Assignee
NewAssignee True string

Unique ID or email address of new Assignee

Action to Reassign
RecordActionUri True integer
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Remove All Actions)

Removes all actions attached to the specified record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Remove Location from Access Controls)

RemoveAccessControl

Parameters

Name Key Required Type Description
Unique Identifier
Uri True integer
FunctionEnum
FunctionEnum string
Unique ID
Uri integer

Location Unique Identifier

Returns

Update Record (Reopen)

Use the ReopenRecord function to re-open a closed container. Because re-opening a record may require updating many contained records, this function commits the changes automatically

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Continue on Error?
ContinueOnError boolean
Log Results?
LogResults boolean

Return a text log of the Records reopened in the Log Message property?

Unfinalize Contents?
UnfinalizeContents boolean
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Replace Access Controls)

SetAccessControl

Parameters

Name Key Required Type Description
Unique Identifier
Uri True integer
FunctionEnum
FunctionEnum string
Unique ID
Uri integer

Location Unique Identifier

Returns

Update Record (Request Rendition)

Allows you to create a request for the automatic rendering engine to make a rendition of a record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Rendition Type
RenditionType True string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Reschedule Actions)

Reschedules all actions attached to this record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
From Base Date
FromBaseDate date
Use Actual Durations
UseActualDurations boolean
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Set Access Unrestricted or Based on Container)

InheritAccessControl

Parameters

Name Key Required Type Description
Unique Identifier
Uri True integer
FunctionEnum
FunctionEnum string
Unique ID
Uri integer

Location Unique Identifier

Returns

Update Record (Set Assignee)

Set the Assignee to a particular Location, back to Home or register as Missing

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
New Assignee
NewAssignee string

Unique ID or email address of new Assignee

Assignee Type
AssigneeType string
Due for Return by Date
DueForReturnByDate date
Actual Time Change Occurred
ActualTimeChangeOccurred date-time
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Set User Label)

Allows for the setting of a user label on a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Record
Uri True integer

The Unique ID of the Record to attach the User Label to

User Label
UserLabel True string

The Unique ID or Name of the User Label to apply

Favourite Type
FavouriteType string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Undispose)

Reverts the state of the record (and any of its contents) so that it is no longer disposed

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Continue on error?
ContinueOnError boolean
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Undo Checkout)

Undo a previous checkout of the electronic document for this Record, disregarding any changes made since it was checked out

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer
Comments
Comments string
Properties
Properties string

A comma delimited list of properties to return

Returns

Update Record (Unfinalise - Set As Draft)

Update a Finalised Record to Draft

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

Unique Identifier
Uri True integer

Returns

Upload Electronic File

Upload an Electronic File which may later be attached to a Record

Parameters

Name Key Required Type Description
User to Impersonate
userToImpersonate string

The Network Login or Alternative Login of the Location in CM to impersonate

File Name
RecordFilePath True string
Unique Identifier
Uri True string

Definitions

CMRecord

Name Path Type Description
File Path
RecordFilePath string

The filename as it appears in the Uploads folder

Accession Number
RecordAccessionNumber integer
Addressee
RecordAddressee integer
Alternative Container
RecordAlternativeContainer integer
Assignee
RecordAssignee integer
Author
RecordAuthor integer
Authorization Method
RecordAuthorizationMethod string
Auto Classification Confidence Level
RecordAutoClassificationConfidenceLevel integer
Auto Render to PDF On Save
RecordAutoRenderToPDFOnSave boolean
Blue Print Title
RecordBlueprintTitle string
Bypass Record Type Access Controls
RecordBypassRecordTypeAccessControls boolean
Checked In By
RecordCheckedInBy integer
Checked Out To
RecordCheckedOutTo integer
Classification
RecordClassification integer
Class of Record
RecordClassOfRecord string
Client
RecordClient integer
Client Record
RecordClientRecord integer
Consignment
RecordConsignment string
Consignment Object
RecordConsignmentObject string
Container
RecordContainer integer
Creator
RecordCreator integer
Current Version
RecordCurrentVersion string
Date Closed
RecordDateClosed date-time
Date Created
RecordDateCreated date-time
Date Due
RecordDateDue date-time
Date Finalized
RecordDateFinalized date-time
Date Imported
RecordDateImported date-time
Date Inactive
RecordDateInactive date-time
Date Modified
RecordDateModified date-time
Date Published
RecordDatePublished date-time
Date Received
RecordDateReceived date-time
Date Registered
RecordDateRegistered date-time
Document Attach Pending
RecordDocumentAttachPending boolean
Document Size
RecordDocumentSize integer
Document Type
RecordDocumentType string
Editor
RecordEditor integer
Electronic Document Store
RecordEStore integer
Document Extension
RecordExtension string
External Reference
RecordExternalReference string
Finalize on Save
RecordFinalizeOnSave boolean
Folder Origin
RecordFolderOrigin integer
Foreign Barcode
RecordForeignBarcode string
Generated Title
RecordGeneratedTitle string
GPS Location
RecordGpsLocation string
Home Location
RecordHomeLocation integer
Home Space
RecordHomeSpace integer
Initiate Template
RecordInitiateTemplate string

Unique ID of Workflow Template

Is Enclosed
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Last Action Date
RecordLastActionDate date-time
Last Part Record
RecordLastPartRecord integer
Latest Version
RecordLatestVersion integer
Expanded Number
RecordLongNumber string
Record Number
RecordNumber string
Manual Destruction Date
RecordManualDestructionDate date-time
Matter Record
RecordMatterRecord integer
Media Type
RecordMediaType string
Meeting
RecordMeeting integer
Mime Type
RecordMimeType string
My Authorization Comments
RecordMyAuthorizationComments string
My Authorization Complete
RecordMyAuthorizationComplete boolean
My Review Comments
RecordMyReviewComments string
My Review Complete
RecordMyReviewComplete boolean
Number Pages?
RecordNbrPages integer
Needs Authorization?
RecordNeedsAuthorization boolean
Needs Review?
RecordNeedsReview boolean
New Part Creation Rule
RecordNewPartCreationRule string

Unique ID of Auto Part Creation Rule

Next Part Record
RecordNextPartRecord integer
Notes Update Type
NotesUpdateType string
Notes
RecordNotes string
Originated From
RecordOriginatedFrom string
Originated From Run
RecordOriginatedFromRun string
Other Contact
RecordOtherContact integer
Owner Location
RecordOwnerLocation integer
Preserver Hierarchy On Data Entry?
RecordPreserveHierarchyOnDataEntry boolean
Previous Part Record
RecordPrevPartRecord integer
Primary Contact
RecordPrimaryContact integer
Priority
RecordPriority string
Record Type
RecordRecordType integer
Related Record
RecordRelatedRecord integer
Representative
RecordRepresentative integer
Retention Schedule
RecordRetentionSchedule integer
Review Date
RecordReviewDate date-time
Review Due Date
RecordReviewDueDate date-time
Review State
RecordReviewState string
Root Part Record
RecordRootPartRecord integer
Security
RecordSecurity string
Series Record
RecordSeriesRecord integer
Title
RecordTitle string
Title (Free Text Part)
RecordTypedTitle string
Unique Identifier
Uri integer
Additional Fields
Fields object

CMEventData

Name Path Type Description
Event Unique Identifier
OnlineEventUri integer
Event Type ID
EventType integer
Event Type
EventTypeString string
Event Date
EventDate date-time
Object Type ID
ObjectType integer
Object Type
ObjectTypeString string
Object Unique ID
ObjectUri integer
Related Object Type ID
RelatedObjectType integer
Related Object Type
RelatedObjectTypeString string
Related Object Unique ID
RelatedObjectUri integer
From Machine
FromMachine string
Connection IP Address
ConnectionIPAddress string
Client IP Address
ClientIPAddress string
From Time Zone
FromTimeZone integer
Login Name
LoginName string
Login Unique ID
LoginUri integer
Extra Details
ExtraDetails string

CMLogMessage

Name Path Type Description
Log Message
LogMessage string
Search for
TrimType CMTrimType
Unique Identifier
Uri integer

CMRecordsResponse

Name Path Type Description
Results
Results array of CMRecord
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Total Results
TotalResults integer
Count String Ex
CountStringEx string
Minimum Count
MinimumCount integer
Count
Count integer
Has More Items
HasMoreItems boolean
Search Title
SearchTitle string
Hit Highlight String
HitHighlightString string
Search for
TrimType CMTrimType
Response Status
ResponseStatus CMResponseStatus

Response Status

CMLogResponse

Name Path Type Description
Results
Results array of CMLogMessage
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Total Results
TotalResults integer
Count String Ex
CountStringEx string
Minimum Count
MinimumCount integer
Count
Count integer
Has More Items
HasMoreItems boolean
Search Title
SearchTitle string
Hit Highlight String
HitHighlightString string
Search for
TrimType CMTrimType
Response Status
ResponseStatus CMResponseStatus

Response Status

CMUpdateErrorResponse

Update Error Response

Name Path Type Description
Error Code
ErrorCode string
Unique Identifier
Uri integer
Message
Message string
Name
Name string
Name (Extra)
NameExtra string

CMResponseStatus

Response Status

Name Path Type Description
Error Code
ErrorCode string
Message
Message string
StackTrace
StackTrace string
Errors
Errors array of CMResponseError
Meta
Meta object

Dictionary<String,String>

CMResponseError

Response Error

Name Path Type Description
Error Code
ErrorCode string
Field Name
FieldName string
Message
Message string
Meta
Meta object

Dictionary<String,String>

CMTrimType

Search for
string

CMLocation

Name Path Type Description
Unique Identifier
Uri integer
Name
NameString string
Location Full Formatted Name
LocationFullFormattedName string
Location Sort Name
LocationSortName string

CMBob

Name Path Type Description
Unique Identifier
Uri integer
Name
NameString string

CMLocationsResponse

Name Path Type Description
Results
Results array of CMLocation

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Total Results
TotalResults integer
Count String Ex
CountStringEx string
Minimum Count
MinimumCount integer
Count
Count integer
Has More Items
HasMoreItems boolean
Search Title
SearchTitle string
Hit Highlight String
HitHighlightString string
Search for
TrimType CMTrimType
Response Status
ResponseStatus CMResponseStatus

Response Status

CMBobResponse

Name Path Type Description
Results
Results array of CMBob

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Total Results
TotalResults integer
Count String Ex
CountStringEx string
Minimum Count
MinimumCount integer
Count
Count integer
Has More Items
HasMoreItems boolean
Search Title
SearchTitle string
Hit Highlight String
HitHighlightString string
Search for
TrimType CMTrimType
Response Status
ResponseStatus CMResponseStatus

Response Status

GetFileFromUrlResponse

Response from the 'GetFileFromUrl' CM Service API plugin.

Name Path Type Description
Filepath
Filepath string

Local file path to the file downloaded from the URL.

Message
Message string

CMLocationAddressUri

Name Path Type Description
Unique ID
Uri integer

binary

This is the basic data type 'binary'.

object

This is the type 'object'.