Result Objects. salesforce Metadata API
Advertisement
Advertisement
CHAPTER 9
Result Objects
Use the following objects to get the results of your file-based
or
IN THIS SECTION:
Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.
Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.
Contains information about the success or failure of the associated deploy()
call.
Contains information about the organization that is useful for developers working with declarative metadata.
Contains information about a value type that is useful for developers working with declarative metadata.
Contains result information for the readMetadata
call.
Contains information about the success or failure of the associated retrieve()
call.
Contains result information for the createMetadata
, updateMetadata
, or renameMetadata
call.
Contains result information for the deleteMetadata
call.
Contains information about the result of the associated upsertMetadata()
call.
Represents an error that occurred during a synchronous CRUD ( createMetadata()
, updateMetadata()
, or deleteMetadata()
) operation.
AsyncResult
Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata call.
87
Result Objects AsyncResult
API Version 31.0 and Later
Also, the asynchronous create()
, update()
, and delete()
calls have been removed. Therefore, only the id
field in AsyncResult is used. The id
field is the ID of a deployment or retrieval.
AsyncResult is returned by the following asynchronous calls.
•
•
AsyncResult has the following field that is in use.
Name
id
Type
ID
Description
Required. The ID of the component that’s being deployed or retrieved.
All fields in AsyncResult other than id
are deprecated as of API version 31.0. These fields exist but are no longer in use.
•
done
•
message
•
state
•
statusCode
API Versions 29.0 and 30.0
ones, to improve the process for getting information about deployments. For more information about these changes, see
In API versions 29.0 and 30.0, AsyncResult is returned by the same asynchronous calls as in API version 28.0 and earlier, but it has different fields.
Name
done id message state
Type
boolean
ID
Description
Required. Indicates whether the call has been completed ( true
) or not
( false
).
Required. The ID of the component that’s being created, updated, deleted, deployed, or retrieved.
The message that corresponds to the returned
field, if any.
string
AsyncRequestState
(
type string)
Required. The
AsyncRequestState
object has one of four possible values.
•
Queued
: This call has not started. It is waiting in a queue.
•
InProgress
: This call has started but has not been completed.
•
Completed
: This call has been completed.
•
Error
: An error occurred. See the statusCode
88
Result Objects
Name
statusCode
AsyncResult
Type
StatusCode
(
type string)
Description
If an error occurred during the create()
a status code is returned, and the message that corresponds to the status code is returned in the
field.
For a description of each StatusCode value, see “StatusCode” in the SOAP API
Developer's Guide .
API Version 28.0 and Earlier
In API version 28.0 and earlier, AsyncResult is returned by the following asynchronous calls.
•
•
•
•
•
Use the
AsyncResult object as the call is completed or when errors occur.
calls use AsyncResult, though you must subsequently use checkDeployStatus()
or
respectively to get more status information for the deployment or retrieval.
AsyncResult has the following fields.
Name
checkOnly done id
Type
boolean boolean
ID message string numberComponentErrors int numberComponentsDeployed int
Description
Indicates whether this deployment is being used to check the validity of the deployed files without making any changes in the organization ( true
) or not
( false
). A check-only deployment does not deploy any components or change the organization in any way. This field is available in API version 16.0
and later and is relevant only for the deploy()
Required. Indicates whether the call has been completed ( true
) or not
( false
).
Required. The ID of the component that’s being created, updated, deleted, deployed, or retrieved.
The message that corresponds to the returned
field, if any.
The number of components that generated errors during this deployment.
This field is available in API version 16.0 and later and is relevant only for the
call.
The number of components that have been deployed for this deployment.
This field in conjunction with the numberComponentsTotal
you an indication of the progress of the deployment. This field is available in
API version 16.0 and later and is relevant only for the deploy()
89
Result Objects AsyncResult
Name
numberComponentsTotal numberTestErrors numberTestsCompleted numberTestsTotal secondsToWait state
Type
int int int int int
Description
The total number of components in the deployment. This field in conjunction with the
field gives you an indication of
the progress of the deployment. This field is available in API version 16.0 and
later and is relevant only for the deploy()
The number of Apex tests that generated errors during this deployment. This field is available in API version 16.0 and later and is relevant only for the
call.
The number of Apex tests that have been completed for this deployment. This field in conjunction with the
field gives you an indication of the progress of tests for the deployment. This field is available in
API version 16.0 and later and is relevant only for the deploy()
The total number of Apex tests in the deployment. This field in conjunction
field gives you an indication of the progress of tests for the deployment. The value in this field is not accurate until the deployment has started running tests for the components that are being deployed. This field is available in API version 16.0 and later and is relevant only for the
call.
This field is no longer supported for API version 13.0 and later and is provided only for backward compatibility. The field was removed in API version 17.0.
Indicates the number of seconds before the call is likel to be completed. This is an estimate only. A reasonable approach is to wait one second before calling checkStatus()
to see if the operation is complete. Double your wait time for each successive iteration of checkStatus()
calls until the operation is complete.
AsyncRequestState
(
type string)
Required. The
AsyncRequestState
object has one of four possible values.
•
Queued
: This call has not started. It is waiting in a queue.
•
InProgress
: This call has started but has not been completed.
•
Completed
: This call has been completed.
•
Error
: An error occurred. See the statusCode
stateDetail stateDetailLastModifiedDate statusCode string dateTime
StatusCode
(
type string)
Indicates which component is being deployed or which Apex test class is running. This field is available in API version 16.0 and later and is relevant only for the
call.
The date and time when the stateDetail
field was last modified. This field is available in API version 16.0 and later and is relevant only for the
call.
If an error occurred during the
,
,
, or
call, a status code is returned, and the message that corresponds
to the status code is returned in the message
field.
For a description of each StatusCode value, see “StatusCode” in the SOAP API
Developer's Guide .
90
Result Objects CancelDeployResult
CancelDeployResult
Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.
The asynchronous metadata call cancelDeploy()
returns a
CancelDeployResult
object.
Version
Available in API version 30.0 and later.
CancelDeployResult
has the following properties.
Name
done
Type
boolean id
ID
Description
Indicates whether the deployment cancellation, which is started through cancelDeploy()
, has completed ( true
) or not ( false
).
When a deployment hasn’t started yet and is still in the queue, the deployment is canceled immediately with the cancelDeploy()
call and this field returns true
. Otherwise, this field returns false
when the cancellation is in progress.
ID of the deployment being canceled.
DeployResult
Contains information about the success or failure of the associated deploy()
call.
The asynchronous metadata call checkDeployStatus()
returns a DeployResult object.
In API version 29.0, Salesforce moved several properties from the
on page 87 object to the DeployResult object to improve the process for getting information about deployments. For more information about these changes, see
on page 33.
For API version 29.0 and later, the DeployResult object has the following properties.
Name
id canceledBy canceledByName checkOnly completedDate
Type
ID
ID string boolean dateTime
Description
ID of the component being deployed.
The ID of the user who canceled the deployment.
This field is available in API version 30.0 and later.
The full name of the user who canceled the deployment.
This field is available in API version 30.0 and later.
Indicates whether this deployment is being used to check the validity of the deployed files without making any changes in the organization ( true
) or not
( false
). A check-only deployment does not deploy any components or change the organization in any way.
Timestamp for when the deployment process ended.
91
Result Objects DeployResult
Name
createdBy createdByName createdDate details done errorMessage errorStatusCode ignoreWarnings lastModifiedDate numberComponentErrors int numberComponentsDeployed int numberComponentsTotal numberTestErrors dateTime int numberTestsCompleted int numberTestsTotal
Type
ID string dateTime
boolean string string boolean int int
Description
The ID of the user who created the deployment.
This field is available in API version 30.0 and later.
The full name of the user who created the deployment.
This field is available in API version 30.0 and later.
Timestamp for when the deploy()
call was received.
Provides the details of a deployment that is in-progress or ended, if the includeDetails
parameter is set to true
in the
call.
Indicates whether the server finished processing the deploy()
call for the specified id
.
Message corresponding to the values in the errorStatusCode
field, if any.
If an error occurred during the deploy()
call, a status code is returned, and the
message corresponding to the status code is returned in the errorMessage field.
For a description of each StatusCode value, see “StatusCode” in the
SOAP API
Developer's Guide
.
Optional. Defaults to false
. Specifies whether a deployment should continue even if the deployment generates warnings. Do not set this argument to true for deployments to production organizations.
Timestamp of the last update for the deployment process.
The number of components that generated errors during this deployment.
The number of components deployed in the deployment process. Use this value
with the numberComponentsTotal
value to get an estimate of the
deployment’s progress.
The total number of components in the deployment. Use this value with the
value to get an estimate of the deployment’s
progress.
The number of Apex tests that have generated errors during this deployment.
The number of completed Apex tests for this deployment. Use this value with the
value to get an estimate of the deployment’s test
progress.
The total number of Apex tests for this deployment. Use this value with the
value to get an estimate of the deployment’s test
progress. The value in this field is not accurate until the deployment has started running tests for the components being deployed.
92
Result Objects DeployResult
Name
runTestsEnabled rollbackOnError startDate stateDetail status success
Type
boolean boolean dateTime string
DeployStatus
(
type string) boolean
Description
Indicates whether Apex tests were run as part of this deployment ( true
) or not
( false
). Tests are either automatically run as part of a deployment or can be set to run in
call. For information on when
tests are automatically run, see Running Tests in a Deployment .
This field is available in API version 30.0 and later.
Optional. Defaults to true. Indicates whether any failure causes a complete rollback
( true
) or not ( false
). If false
, whatever set of actions can be performed without errors are performed, and errors are returned for the remaining actions.
This parameter must be set to true
if you are deploying to a production organization.
Timestamp for when the deployment process began.
Indicates which component is being deployed or which Apex test class is running.
Indicates the current state of the deployment. The valid values are:
•
Pending
•
InProgress
•
Succeeded
•
SucceededPartial
•
Failed
•
Canceling
•
Canceled
Indicates whether the deployment was successful ( true
) or not ( false
).
DeployDetails
These fields provide more information for the details
field of the DeployResult object, if the includeDetails
parameter is set to ( true
Note: While a deployment is still in-progress, the DeployDetails object only contains componentFailures
data. After the deployment process finishes, the other fields populate with the data for the entire deployment.
Name Type
componentFailures
componentSuccesses
retrieveResult
Description
One or more DeployMessage objects containing deployment errors for each component.
One or more DeployMessage objects containing successful deployment details for each component.
If the
parameter was specified for the
call is performed immediately after the
process completes. This field contains the results of that retrieval.
93
Result Objects DeployResult
Name
runTestResult
Type
Description
If tests were run for the
call, this field contains the test results. While a deployment is still in-progress, this field only contains error data. After the deployment process finishes, this field populates with the data for the entire deployment.
For API version 28.0 and earlier, the DeployResult object has the following properties.
Name
id
Type
ID messages
retrieveResult
runTestResult success
boolean
Description
ID of the component being deployed.
Contains information about the success or failure of a deploy()
parameter was specified for the
call is performed immediately after the
process completes.
This field contains the results of that retrieval.
If tests were run for the deploy()
call, this field contains the test results.
Indicates whether the deployment was successful ( true
) or not ( false
).
DeployMessage
Each DeployResult object contains one or more DeployMessage objects. Each DeployMessage object contains information about the deployment success or failure of a component in the deployment
.zip
file:
Name
changed columnNumber componentType created createdDate deleted fileName
Type
boolean int string boolean dateTime boolean string
Description
If true
, the component was changed as a result of this deployment. If false
, the deployed component was the same as the corresponding component already in the organization.
Each component is represented by a text file. If an error occurred during deployment, this field represents the column of the text file where the error occurred.
The metadata type of the component in this deployment.
This field is available in API version 30.0 and later.
If true
, the component was created as a result of this deployment. If false
, the component was either deleted or modified as a result of the deployment.
The date and time when the component was created as a result of this deployment.
This field is available in API version 30.0 and later.
If true
, the component was deleted as a result of this deployment. If false
, the component was either new or modified as result of the deployment.
The name of the file in the
.zip
file used to deploy this component.
94
Result Objects DeployResult
Name
fullName id lineNumber problem problemType success
Type
string
Description
The full name of the component.
Inherited from
Metadata , this field is not defined in the WSDL for this metadata type.
It must be specified when creating, updating, or deleting. See
to see an example of this field specified for a call.
ID ID of the component being deployed.
int string
Each component is represented by a text file. If an error occurred during deployment, this field represents the line number of the text file where the error occurred.
If an error or warning occurred, this field contains a description of the problem that caused the compile to fail.
DeployProblemType
of type string)
Indicates the problem type. The problem details are tracked in the problem
The valid values are:
•
Warning
•
Error
This field is available in API version 18.0 and later. Prior to version 18.0, there was no distinction between warnings and errors. All problems were treated as errors and prevented a successful deployment.
boolean Indicates whether the component was successfully deployed ( true
) or not ( false
).
RunTestsResult
Contains information about the execution of unit tests, including whether unit tests were completed successfully, code coverage results, and failures.
A RunTestsResult object has the following properties
Name
apexLogId
Type
string
Description
The ID of an ApexLog object that is created at the end of a test run. The ApexLog object is created if there is an active trace flag on the user running an Apex test, or on a class or trigger being executed.
This field is available in API version 35.0 and later.
codeCoverage failures
codeCoverageWarnings
[]
An array of one or more code coverage warnings for the test run. The results include both the total number of lines that could have been executed, as well as the number, line, and column positions of code that was not executed.
[]
An array of one or more CodeCoverageResult objects that contains the details of the code coverage for the specified unit tests.
An array of one or more RunTestFailure objects that contain information about the unit test failures, if there are any.
95
Result Objects
Name
numFailures numTestsRun successes totalTime
Type
int int
[] double
DeployResult
Description
The number of failures for the unit tests.
The number of unit tests that were run.
An array of one or more RunTestSuccess objects that contain information about successes, if there are any.
The total cumulative time spent running tests. This can be helpful for performance monitoring.
CodeCoverageResult
The
object contains this object. It contains information about whether or not the compile of the specified Apex and run of the unit tests was successful.
Name
dmlInfo
Type
[]
Description
For each class or trigger tested, for each portion of code tested, this property contains the DML statement locations, the number of times the code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.
id
ID
The ID of the
CodeLocation . The ID is unique within an organization.
locationsNotCovered
[]
For each class or trigger tested, if any code is not covered, the line and column of the code not tested, and the number of times the code was executed.
methodInfo
[]
For each class or trigger tested, the method invocation locations, the number of times the code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.
name string
The name of the class or trigger covered.
namespace string
The namespace that contained the unit tests, if one is specified.
numLocations int
The total number of code locations.
soqlInfo
[]
For each class or trigger tested, the location of SOQL statements in the code, the number of times this code was executed, and the total cumulative time spent in these calls. This can be helpful for performance monitoring.
type string
Do not use. In early, unsupported releases, used to specify class or package.
96
Result Objects
CodeCoverageWarning
The
This object has the following properties.
Name
id message
Type
ID string
Description
The ID of the
CodeLocation . The ID is unique within an organization.
The message of the warning generated.
name string
The namespace that contained the unit tests, if one is specified.
namespace string
The namespace that contained the unit tests, if one is specified.
DeployResult
RunTestFailure
The
RunTestsResult object returns information about failures during the unit test run.
This object has the following properties.
Name
id
Type
ID
Description
The ID of the class which generated failures.
message string
The failure message.
methodName string
The name of the method that failed.
name string
The name of the class that failed.
namespace string seeAllData boolean
The namespace that contained the class, if one was specified.
Indicates whether the test method has access to organization data ( true
) or not
( false
).
This field is available in API version 33.0 and later.
stackTrace string
The stack trace for the failure.
time double
The time spent running tests for this failed operation. This can be helpful for performance monitoring.
type string
Do not use. In early, unsupported releases, used to specify class or package.
97
Result Objects DescribeMetadataResult
RunTestSuccess
The
RunTestsResult object returns information about successes during the unit test run.
This object has the following properties.
Name
id
Type
ID
Description
The ID of the class which generated the success.
methodName string
The name of the method that succeeded.
name string
The name of the class that succeeded.
namespace string seeAllData boolean
The namespace that contained the unit tests, if one is specified.
Indicates whether the test method has access to organization data ( true
) or not
( false
).
This field is available in API version 33.0 and later.
time double
The time spent running tests for this operation. This can be helpful for performance monitoring.
CodeLocation
The
RunTestsResult object contains this object in a number of fields.
This object has the following properties.
Name
column
Type
int
Description
The column location of the Apex tested.
line int
The line location of the Apex tested.
numExecutions int
The number of times the Apex was executed in the test run.
time double
The total cumulative time spent at this location. This can be helpful for performance monitoring.
DescribeMetadataResult
Contains information about the organization that is useful for developers working with declarative metadata.
The
call returns a DescribeMetadataResult object.
Each DescribeMetadataResult object has the following properties:
98
Result Objects DescribeValueTypeResult
Name
metadataObjects
Type Description
[] One or more metadata components and their attributes.
organizationNamespace string partialSaveAllowed boolean
The namespace of the organization. Specify only for Developer Edition organizations that can contain a managed package. The managed package has a namespace specified when it is created.
Indicates whether rollbackOnError
true
) or not ( false
).
This value is always :
•
false
in production organizations.
•
the opposite of testRequired
.
testRequired boolean Indicates whether tests are required ( true
) or not ( false
).
This value is always the opposite of partialSaveAllowed
.
DescribeMetadataObject
This object is returned as part of the DescribeMetadataResult. Each DescribeMetadataObject has the following properties:
Name Type
childXmlNames string[] directoryName string inFolder boolean metaFile suffix xmlName boolean string string
Description
List of child sub-components for this component.
The name of the directory in the
.zip
file that contains this component.
Indicates whether the component is in a folder ( true
) or not ( false
). For example, documents, email templates and reports are stored in folders.
Indicates whether the component requires an accompanying metadata file. For example, documents, classes, and s-controls are components that require an additional metadata file.
The file suffix for this component.
The name of the root element in the metadata file for this component. This name also appears in the
Packages
> types
> name
field in the manifest file package.xml
.
DescribeValueTypeResult
Contains information about a value type that is useful for developers working with declarative metadata.
The
call returns a DescribeValueTypeResult object.
Each DescribeValueTypeResult object has the following properties.
99
Result Objects DescribeValueTypeResult
Name
apiCreatable
Type
boolean apiDeletable boolean apiReadable apiUpdatable boolean parentField boolean
valueTypeFields
[]
Description
Indicates whether this value type can be created through the
call ( true
) or not ( false
).
This field is available in API version 36.0 and later.
Indicates whether this value type can be created through the deleteMetadata()
call ( true
) or not ( false
).
This field is available in API version 36.0 and later.
Indicates whether this value type can be created through the
call ( true
) or not ( false
).
This field is available in API version 36.0 and later.
Indicates whether this value type can be created through the updateMetadata()
call ( true
) or not ( false
).
This field is available in API version 36.0 and later.
Information about the parent of this value type. Parent field information is useful for metadata types that are specified with the parent in their name, such as custom fields, email templates, workflow rules, and reports. For example, the full name of a custom field includes the sObject that contains it (for example,
Account.field1__c
). Similarly, the full name of an email template includes the folder where the template is stored (for example,
MyFolder/EmailTemplate1
).
If the value type has no parent, this field is null.
This field is available in API version 36.0 and later.
One or more metadata components and their attributes.
ValueTypeField
This object is returned as part of the DescribeValueTypeResult and represents the metadata for one field. Each ValueTypeField has the following properties.
Name
fields
Type
ValueTypeField foreignKeyDomain string isForeignKey isNameField minOccurs boolean boolean int
Description
The
ValueTypeField
object for the next field, if any.
If isForeignKey
is
True
, foreignKeyDomain
is the type of object, such as Account or Opportunity.
True
if the field is a foreign key. That means this field is the primary key in a different database table.
True
if this value type field is a fullName
field, otherwise
False
.
1 if this field is required, 0 otherwise.
100
Result Objects
Name
name picklistValues soapType valueRequired
Type
string
PicklistEntry string boolean
Description
The name of this value type field. The name is null for parent fields.
The individual picklist values if the field is a picklist.
The data type of the field, such as boolean or double.
Required. Indicates whether this value type field must have a value
( true
) or can be null ( false
).
ReadResult
ReadResult
Contains result information for the readMetadata
call.
Version
Available in API version 30.0 and later.
Properties
Name
records
Type
Description
An array of metadata components returned from readMetadata()
.
RetrieveResult
Contains information about the success or failure of the associated retrieve()
call.
call returns a RetrieveResult object.
Each RetrieveResult object has the following fields:
Name
done errorMessage errorStatusCode fileProperties
Type
boolean string
StatusCode
[]
Description
Required. Indicates whether the retrieve()
call is completed ( true
) or not ( false
).
This field is available in API version 31.0 and later.
If an error occurs during the retrieve()
call, this field contains a descriptive message about this error. This field is available in API version 31.0 and later.
If an error occurs during the retrieve()
call, this field contains the status code for this error. This field is available in API version 31.0 and later.
For a description of each StatusCode value, see “StatusCode” in the
SOAP API Developer's
Guide
.
Contains information about the properties of each component in the
.zip
file, and the manifest file package.xml
. One object per component is returned.
101
Result Objects RetrieveResult
Name
id messages status success zipFile
Type
ID
Description
ID of the component being retrieved.
Contains information about the success or failure of the retrieve()
call.
RetrieveStatus
string)
The status of the retrieve()
call. Valid values are:
•
Pending
•
InProgress
•
Succeeded
•
Failed
This field is available in API version 31.0 and later.
boolean base64Binary
Indicates whether the retrieve()
call was successful ( true
) or not ( false
). This field is available in API version 31.0 and later.
The zip file returned by the retrieve request. Base 64-encoded binary data. Prior to making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is usually handled for you by a SOAP client.
FileProperties
This component contains information about the properties of each component in the
.zip
file, and the manifest file package.xml
.
One object per component is returned. Note that this component does not contain information about any associated metadata files in the
.zip
file, only the component files and manifest file. FileProperties contains the following properties:
Name
createdById createdByName createdDate fileName fullName
Type
string string dateTime string string id string lastModifiedById string lastModifiedByName string lastModifiedDate dateTime
Description
Required. ID of the user who created the file.
Required. Name of the user who created the file.
Required. Date and time when the file was created.
Required. Name of the file.
Required. The file developer name used as a unique identifier for API access.
The value is based on the fileName
but the characters allowed are more
restrictive. The fullName
can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Required. ID of the file.
Required. ID of the user who last modified the file.
Required. Name of the user who last modified the file.
Required. Date and time that the file was last modified.
102
Result Objects SaveResult
Name
manageableState
Type
ManageableState
string) namespacePrefix type string string
Description
Indicates the manageable state of the specified component if it is contained in a package:
•
beta
•
deleted
•
deprecated
•
installed
•
released
•
unmanaged
For more information about states of manageability for components in
Force.com AppExchange packages, see “Planning the Release of Managed
Packages” in the Salesforce online help.
If any, the namespace prefix of the component.
Required. The metadata type, such as
CustomObject
,
CustomField
, or
ApexClass
.
RetrieveMessage
RetrieveResult returns this object, which contains information about the success or failure of the retrieve()
call. One object per problem is returned:
Name
fileName problem
Type
string string
Description
The name of the file in the retrieved
.zip
file where a problem occurred.
A description of the problem that occurred.
SEE ALSO:
SaveResult
Contains result information for the createMetadata
, updateMetadata
, or renameMetadata
call.
Version
Available in API version 30.0 and later.
103
Result Objects
Properties
Name
errors fullName success
Type
string boolean
Description
An array of errors returned if the operation wasn’t successful.
The full name of the component processed.
Indicates whether the operation was successful ( true
) or not ( false
).
DeleteResult
Contains result information for the deleteMetadata
call.
Version
Available in API version 30.0 and later.
Properties
Name
errors fullName success
Type
string boolean
Description
An array of errors returned if the operation wasn’t successful.
The full name of the deleted component.
Indicates whether the deletion was successful ( true
) or not ( false
).
DeleteResult
UpsertResult
Contains information about the result of the associated upsertMetadata()
call.
Version
Available in API version 31.0 and later.
Properties
Name
created
Type
boolean errors
Description
Indicates whether the upsert operation resulted in the creation of the component ( true
) or not ( false
). If false
and the upsert operation was successful, this means that the component was updated.
An array of errors that were returned if the operation wasn’t successful.
104
Result Objects
Name
fullName success
Type
string boolean
Description
The full name of the component that was created or updated if the operation was successful.
Indicates whether the operation was successful ( true
) or not ( false
).
Error
Represents an error that occurred during a synchronous CRUD ( createMetadata()
, updateMetadata()
, or deleteMetadata()
) operation.
Version
Available in API version 30.0 and later.
Properties
Name Type
extendedErrorDetails
ExtendedErrorDetails fields message statusCode string[] string
StatusCode
Description
More details about the error, including an extended error code and extra error properties, when available. Reserved for future use.
For a description of the ExtendedErrorDetails element, see
“ExtendedErrorDetails” in the
SOAP API Developer's Guide
.
An array containing names of fields that affected the error condition.
The error message text.
A status code corresponding to the error.
For a description of each StatusCode value, see “StatusCode” in the
SOAP API Developer's Guide
.
Error
105
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
