This API enables redlining capability for a list of documents, specified in the docIds, by using the parameters, such as sObjectID and pLevel.


API

Signature

enableAuthoring

webService static Boolean enableAuthoring(Id sObjectId, String pLevel, List docIds, String sessionId, String serverUrl)



Request Parameters
NameTypeDescriptionRequired?
sObjectIdIDThe ID of the standard object for which authoring is to be enabled.Yes
pLevelStringThe protection level to apply to the document. Valid values are
  • Full access
  • Insert comments only
  • Insert comments and tracked changes only
  • Read only
  • Fill in form fields only
Yes
docIdsList

The ids of the documents for which you want to enable authoring. If the value is null, all the documents associated with the sObject are enabled. You can list comma separated docIds.

Yes
sessionIdStringThe Salesforce session id.Yes
serverUrlStringThe Salesforce server id.Yes
Response Parameter
NameTypeDescription
resultBooleanIndicates if the authoring was enabled successfully for the listed documents.


Code Sample

ID sObjectId = 'a016100000Che3D';
String pLevel = 'Full access';
ID[] docIds = new ID[]
{'a0Y61000002K6IR','a0Y61000003K7jR'};
String sessionId = sessionId; //This is the session Id.
String serverUrl = System.Url.getSalesforceBaseUrl().toExternalForm() + '/services/Soap/u/14.0/' + UserInfo.getOrganizationId();

Boolean success = Apttus.MergeWebService.enableAuthoring(sObjectId,pLevel,docIds,sessionId,serverUrl);
CODE

Integration Details

Use the following information in your integrations with Apttus Contract Management Web Services API. For information on how to get started, refer to Integrating Apttus with External Systems.

API Prerequisites

None.

Request/Response XML

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
   <soapenv:Header>
           <mer:SessionHeader>
         <mer:sessionId>00D020000008lUh!AQYAQPYE.vw_Vh7FI.cV871nm9WWqIdhVINQJIl7PDNzr3fLVNdGjwk9qTJbDYIRoxbfpa44bpuIyeyVxEepPxdubr_AWjOv</mer:sessionId>
      </mer:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <mer:enableAuthoring>
         <mer:sObjectId>a07020000008w91</mer:sObjectId>
         <mer:pLevel>Full Access</mer:pLevel>
          <mer:docIds>00P02000000IY8Q</mer:docIds>
          <mer:docIds>00P02000000IY8p</mer:docIds>
         <mer:sessionId>00D020000008lUh!AQYAQPYE.vw_Vh7FI.cV871nm9WWqIdhVINQJIl7PDNzr3fLVNdGjwk9qTJbDYIRoxbfpa44bpuIyeyVxEepPxdubr_AWjOv</mer:sessionId>
         <mer:serverUrl>https://testmanaged--5s20minor.my.salesforce.com/services/Soap/u/49.0/00D020000008lUh</mer:serverUrl>
      </mer:enableAuthoring>
   </soapenv:Body>
</soapenv:Envelope>
XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
   <soapenv:Body>
      <enableAuthoringResponse>
         <result>true</result>
      </enableAuthoringResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML