Gets the details of a company job log.
The logMessage
response field is localized based on the authHeader
locale
field.
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
Input (getJobLogDetailsParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string | Yes | The handle to the company to which the job log belongs. |
jobHandle | xsd:string | No | A handle to an active or completed job. |
originalName | xsd:string | No | Original name of the job log. |
logTypeArray | types:StringArray | No | One or more Log Type constants. If present, only the specified log types will be returned. By default, all log types are returned. |
recordsPerPage | xsd:int | No | Maximum number of detailArray items to return. The maximum and default value is 1000. |
resultsPage | xsd:int | No | Page number of recordsPerPage-results to return. The default value is 1. |
sortBy | xsd:string | No | One of the Job Detail Sort Field constant values (Date or LogType). The default value is Date. |
sortDirection | xsd:string | No | One of the Sort Direction string constants. The default value is ascending. |
Output (getJobLogDetailsReturn)
Name | Type | Required | Description |
---|---|---|---|
* jobLogArray* |
types:JobLogArray |
Yes | Array of job logs. |
This code sample returns all the job log details for a specific company. The first array contains standard job log details. An embedded array returns additional information about the job.
Request
<ns1:getJobLogDetailsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:jobHandle>47||Add_2007-09-14-15:04:34</ns1:jobHandle>
</ns1:getJobLogDetailsParam>
Response
<getJobLogDetailsReturn 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>some_address@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>
<detailArray>
<items>
<logMessage>Upload has begun!</logMessage>
<logType>BeginUpload</logType>
</items>
<items>
<logMessage>Add_2007-09-14-15:04:34</logMessage>
<logType>OriginalJobName</logType>
</items>
<items>
<logMessage>s7oslo</logMessage>
<logType>JobClient</logType>
</items>
...
</detailArray>
</items>
</jobLogArray>
</getJobLogDetailsReturn>