The NovatusRequestBundleincludes a collection of NovatusRequest objects, as well as information about the requester and company the requests are associated with. Only one of the companyId or companyName should be set – the companyId is a reference to an existing company and companyName is the name of a new company. The ID must not be included when creating a new bundle, and must be included when resubmitting a bundle.
Field Name
Type
Description
id
String
The unique identifier of the bundle
requests
List<NovatusRequest>
Collection of requests in the bundle
requestBundleConfigName
String
The name of the request bundle type (from Admin > Contract Request Types in application)
companyId
String
The unique identifier of the company
companyName
String
The name of the company
requesterName
String
The name of the person making the request
requesterEmail
String
The email address of the person making the request
NovatusRequest Object
The NovatusRequestincludes a NovatusCompany object, a NovatusContract object, and collections of document identifiers, NovatusContractResponsibility objects, and NovatusDynamicForm objects. These contain the data about the objects that will be created when the request is approved. In the NovatusDynamicForm collection, only the configId and dynamics fields are used. The requestDocuments field contains the identifiers of documents that have previously been uploaded to the system through the Request API's addDocument method.
Field Name
Type
Description
requestConfigName
String
The name of the request type (In the application, the title of the tab in the bundle)
company
NovatusCompany
Company data to include in the request
contract
NovatusContract
Contract data to include in the request
responsibility
List<NovatusContractResponsibility>
Responsibilities to include on the contract
dynamicForms
List<NovatusDynamicForm>
Dynamic forms to include with the request
requestDocuments
List<String>
Unique identifiers of unattached documents to include with the request
Request Service
The request service behaves somewhat differently than other services. The create method creates a new request. When the request is created it is the responsibility of the client to store the returned ID for resubmission through the update method. Also included is an addDocument method that uploads a document unattached to an object for inclusion into a NovatusRequest object. The addDocument method otherwise is identical to that in the Document service.