Post Author: yura.tkachenko
CA Forum: Nsite
There are a lot of calls available in Web Service API v.3, here is list of functions:
login (create WS API session which is valid 15,30,60 minutes -
actually depends of company settings). Return back to user generated
unique sessionId, serverUrl (usually you need pass serverUrl as a new
endpoint of WebService). But we are recommend do not use serverUrl better use cookie-based approach (on client side you need to tell your soap stack to maintain cookies).
logoff - finish active session (requires sessionId parameter)queryObject - return EnterpriseObject data (instances). Using that call you can query headers, detail sections, apply pagination for both headers, details. Also you can query such administrative objects: Company (company information - as one user can belong only to one company so at any time you can query only one record), User (list of users settings), Attachment (using that object you can query any attachment assigned with any Enterprise Object). insertObject - add new record to EnterpriseObject, User (only if you are administrator in the company), Attachment (add new attachment)updateObject - edit existing objects: Enterprise Object(headers, details), User (change your profile, edit profile of other users if you are administrator), Company (edit company settings), Attachment (edit attachments).deleteObject - delete : Enterprise Objects or edit Enterprise Objects (deleting row in detail section), Attachment (delete attachments). Nsite doesn't support deleting such entities from system as: User, Company.copyObject - copy exiting Enterprise Object (instance) to another instace with all nested (details, attachments, header fields).describeObject - retrieves full meta description of Enterprise Object (header fields, detail sections, relationships with other EOs). Also this method retrieve description about administrative objects: Company, User, Attachment.describeSystem - retrieves company settings (Company object). You can simulate this call using queryObject operation.getObjectsList - retrieves list of available EnterpriseObjects and administrative objects.getUsersList - retrieves list of company's users.describeUser - retrieves user specific information (User object record). You can simulate this call also using queryObject operation.getCompanyLookups - retrieves available lookups for current company.getLookup - get lookup values and general information about lookup by lookup path. Usually lookup path is assigned to drop-down in Enterprise Object definition. So sometimes very useful to know what values acceptable by EnterpriseObject1 in drop-down1.createLookup - add new lookup to system. This lookup will be available automatically in the Application Designer or others tools.updateLookup - change lookup values etc.uploadAttachment - assign new attachment with "Attachment" component of EO or with "Attach" button (global attachment). This function using DIME attachments - so you need to be sure that your soap stack support this method. You can upload attachments also using insertObject (using Attachment object), but this call work faster for big files.downloadAttachment - download attachment(assigned with "Attachment" component or "Attach" button) using DIME attachments. The same behavior can be reproduce with queryObject call, but this call work faster.describeRouting - get information about any routing in the nSite system. You can get information like: routing status, list of participants, etc.routeEO - start routing mechanism for Enterprise Object.approveEO - approve routing. Current user should be approver.rejectEO - reject routing. Current user should be approver.stopEO - stop routing. Current user should be initiator of routing.We have such limitation of our API:Doesn't support running Business Rules if something was changes in EO instance using calls: insertObject, updateObject, deleteObject.Doesn't support Enterprise Objects which is marked as "version enabled" in Application Designer.Doesn't support forwarding of routings.Doesn't support to modify EnterpriseObject structure (definition).Doesn't support manipulations with Roles Based Access Component.