Web Services Operations

• Create and Edit Operation »
• Read Operation »
• Authentication
• Delete Operation
• Publish Operation
• Message Operations
• Read Audits Operation
• Access Rights Operations
• Batch Operation
• Workflow and Web Services Operations
• Introduction to Web Services Operations
• Authenticate Operation
• Search Operation

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Read Audits Operation

To read the audits for an asset simply use the readAudits operation defined by the schema below.

<element name="readAudits"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> <element maxOccurs="1" minOccurs="1" name="auditParameters" nillable="false" type="impl:auditParameters"/> </sequence> </complexType> </element>

The auditParameters argument allows selecting assets and focusing on audits of a certain nature. Here is the schema for auditParameters.

<!-- Parameters when getting the audits from the system --><complexType name="auditParameters"> <sequence> <!-- Filter the assets by a certain entity NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="identifier" type="impl:identifier"/> <!-- Filter the audits by a given user name NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="username" type="xsd:string"/> <!-- Filter the audits by a given group name. The audits for all users in the group will be returned NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="groupname" type="xsd:string"/> <!-- Filter the audits by a given role. NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="rolename" type="impl:roles"/> <!-- Filter the audits by a start time. Only audits for events that happened after this time will be included. NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="startDate" type="xsd:dateTime"/> <!-- Filter the audits by an end time. Only audits for events that happened before this time will be included. NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="endDate" type="xsd:dateTime"/> <!-- Filter the audits by an audit type. Only audits of this type will be returned in the response NOT REQUIRED --> <element maxOccurs="1" minOccurs="0" name="auditType" type="impl:auditTypes"/> </sequence> </complexType>

 The auditTypes property allows for filtering audits based on the type of the audit.

<!-- Represents the different kinds of audits in the system --><simpleType name="auditTypes"> <restriction base="xsd:string"> <enumeration value="login"/> <enumeration value="login_failed"/> <enumeration value="logout"/> <enumeration value="start_workflow"/> <enumeration value="advance_workflow"/> <enumeration value="edit"/> <enumeration value="copy"/> <enumeration value="create"/> <enumeration value="reference"/> <enumeration value="delete"/> <enumeration value="delete_unpublish"/> <enumeration value="check_in"/> <enumeration value="check_out"/> <enumeration value="activate_version"/> <enumeration value="publish"/> <enumeration value="unpublish"/> </restriction> </simpleType>

Wiki | Edit