JOC API

Version 2.6.5

Download RAML
JOC API
/audit_log
POST

Gets the audit log


Parameters in the POST body schema

Name Type Description Example Default
controllerId optional, string Controller ID myController
dateFrom optional, string The value has multiple formats
  • Filters items starting from a date.
  • an ISO 8601 date format with the time offset and milliseconds being optional, e.g.
    • YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
    • YYYY-MM-DDThh:mm:ss[.s][+01:00]
    • YYYY-MM-DDThh:mm:ss[.s][+0100]
    • YYYY-MM-DDThh:mm:ss[.s][+01]
  • a format for a period relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier:
    • s (seconds)
    • m (minutes)
    • h (hours)
    • d (days)
    • w (weeks)
    • M (months)
    • y (years)
  • a time offset is optional (e.g. 2d+02:00)
    • it can also be specified with the parameter timeZone
    • if timeZone is undefined then UTC is used
  • the value 0 indicates the current time
1d
dateTo optional, string The value has multiple formats similiar to the dateFrom parameter
  • Filters items ending before a date.
0
timeZone optional, string
  • If this parameter is set then it beats the time offset in dateFrom and dateTo
  • See the list for available time zones.
Europe/Berlin
folders optional, array[object] Limits the result to a collection of folders [{
"folder": "/sos",
"recursive": true
}]
objectTypes optional, array Limits results to specified types of processed objects. Possible values are
  • "WORKFLOW"
  • "JOBRESOURCE"
  • "LOCK"
  • "FILEORDERSOURCE"
  • "NOTICEBOARD"
  • "WORKINGDAYSCALENDAR"
  • "NONWORKINGDAYSCALENDAR"
  • "SCHEDULE"
  • "INCLUDESCRIPT"
  • "JOBTEMPLATE"
  • "DOCUMENTATION"
  • "ORDER"
["ORDER"]
objectName optional, string Limits results to a specified glob pattern of an object's name that supports '*' and '?' as wildcards where
  • * : match zero or more characters
  • ? : match any single character
"my*Workflow"
categories optional, array Limits results to specified categories of the item. Possible values are
  • "INVENTORY"
  • "CONTROLLER"
  • "DAILYPLAN"
  • "DEPLOYMENT"
  • "DOCUMENTATIONS"
  • "CERTIFICATES"
["CONTROLLER","INVENTORY"]
ticketLink optional, string Limits results to a specified glob pattern of a ticket link that supports '*' and '?' as wildcards where
  • * : match zero or more characters
  • ? : match any single character
comment optional, string Limits results to a specified glob pattern of a comment that supports '*' and '?' as wildcards where
  • * : match zero or more characters
  • ? : match any single character
account optional, string Limits result to a specified account
limit optional, integer Limits the number of resulting items, -1=unlimited 5000 10000