Salesforce Docs Portal

ResultItem

Contains the results of an asynchronous API call. When calling the asynchronous API, a ResultItem contains no objects until that request is picked up from the asynchronous queue. The amount of time a call remains in the queue depends on the current system load.

Properties

Name Data Type Description
Client ClientID Specifies the account ownership and context of an object.
ConversationID String Unique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID.
CorrelationID String Identifies correlation of objects across several requests.
CreatedDate DateTime The date and time when the object was created.
CustomerKey String User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
ErrorCode Int Identifies the error of an API request via a numeric code.
ID Int Read-only identifier for an object. Some objects use the ObjectID property as a unique ID.
ModifiedDate DateTime The date and time when the object was last modified.
ObjectID String System-controlled, read-only text string identifier for object.
ObjectState String Not used.
OrdinalID Int Defines position of object within an array of information.
Owner Owner Describes account ownership of subscriber in an on-your-behalf account.
PartnerKey String Unique identifier provided by partner for an object. This property is accessible only via API.
PartnerProperties Array of APIProperty objects A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
RequestID String Unique ID of initial async API call.
RequestObjectType String Defines type of the Request object, such as email or triggered send.
RequestType RequestType Defines request as synchronous or asynchronous API.
StatusCode String Status of async API request.
StatusMessage String Describes the status of an API call.

Sample SOAP Envelope

<Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <RetrieveRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
        <RetrieveRequest>
            <ObjectType>ResultItem</ObjectType>
            <Properties>RequestType</Properties>
            <Filter xmlns:q1="http://exacttarget.com/wsdl/partnerAPI" xsi:type="q1:SimpleFilterPart">
                <Property>RequestID</Property>
                <SimpleOperator>equals</SimpleOperator>
                <Value>69b55db2-c71d-4886-b127-f789c4efe3b7</Value>
            </Filter>
        </RetrieveRequest>
    </RetrieveRequestMsg>
</body>

Related Items