DocumentationDynamic Media Image Production System API

getJobLogs

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Gets specified job logs for the selected company. You can sort by characters, direction, start and end dates, and number of rows.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (getJobLogsParam)

Name
Type
Required
Description
companyHandle
xsd:string
No
The company handle.
userHandle
xsd:string
No
Gets logs for jobs submitted by a specific user.
sortBy
xsd:string
No
Lets you select sort fields.
sortDirection
xsd:string
No
Sort order (ascending or descending).
startDate
xsd:dateTime
No
The date and time of the start of the job log. Provide the time zone with the request for this field.
endDate
xsd:dateTime
No
The date and time of the end of the job log. Provide the time zone with the request for this field.
numRows
xsd:int
No
Maximum number of rows to return.

Output (getJobLogsReturn)

Name
Type
Required
Description
jobLogArray
types: JobLogArray
Yes
Array of job logs.

Examples

This code sample returns IPS job logs for a specific company. You can also use it to return job logs for a specific user or company and user.

Request

<ns1:getJobLogsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getJobLogsParam>

Response

<getJobLogsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <jobLogArray>
      <items>
         <companyHandle>47</companyHandle>
         <jobHandle>47||Add_2007-09-14-15:04:34</jobHandle>
         <jobName>Add_2007-09-14-15:04:34</jobName>
         <submitUserEmail>kmagnusson@adobe.com</submitUserEmail>
         <logType>BeginUpload</logType>
         <startDate>2007-09-14T22:04:58.536-07:00</startDate>
         <fileSuccessCount>2</fileSuccessCount>
         <fileErrorCount>0</fileErrorCount>
         <fileWarningCount>205</fileWarningCount>
         <fileDuplicateCount>0</fileDuplicateCount>
         <fileUpdateCount>0</fileUpdateCount>
         <totalFileCount>0</totalFileCount>
         <fatalError>false</fatalError>
       </items>
   </jobLogArray>
</getJobLogsReturn>
4e9b9d8c-5839-4215-aa35-01b652869681