Trace:

Differences

This shows you the differences between two versions of the page.

--- api [2012/08/07 20:45]
lisa [Function: LookupData]
+++ api [2012/08/07 21:11]
lisa [Action: Third Party Web Service]
@@ Line 326: / Line 326: @@
 **<relation></relation>** - Contained inside of the relations node, the relation node
 defines a single Relation to create.
+^relation Attributes:^^^
+|action |String |The action to perform on the Relationship.  This should be set to “add” when adding a Relationship. |
+|oppositeItemId |String |The Item Id of the Item that you wish to relate the Item you are adding to. |
+|reference |String |An identifier that will be returned with the response to identify each Relationship that was created. |
+|relationType |String |Id of the Relation Type you would like to create.|
+|startingSide |String |Defines which side of the Relation the Item being added will be on.  Valid values are:|
+| ::: | ::: |base – The new Item is on the base side.|
+| ::: | ::: |target – The new Item is on the target side. |
+**Response XML** - Below is a description of the valid nodes returned in the Response XML from an AddItem request.
+**<wxResponse></wxResponse>** - The root node for the Response XML document.
+**<callStatus></callStatus>** - Contained inside of the wxResponse node, the
+callStatus node contains the status of the SOAP call.
+^callStatus Attributes: ^^^
+|status |String |The call's status.  Values include success and failure. |
+**<compatibilityLevel></compatibilityLevel>** - Contained inside of the
+wxResponse node, the compatibilityLevel node contains the version of the API that
+was used.
+**<dataSet></dataSet>** - Contained inside of the wxResponse node, One data set is
+returned for each data set in the request document.
+^dataSet Attributes:^^^
+|reference |String |The reference that was defined for the data set in the request document. |
+**<item></item>** - Contained inside of the dataSet node, defines an Item that was
+added to the WorkXpress application.
+^item Attributes: ^^^
+|itemId |String |Id of the Item that was added. |
+|ItemTypeId |String |Item Type id of the Item that was added. |
+**<relation></relation>** - Contained inside of the item node, the relation node
+defines a Relation that was added to the WorkXpress application.
+^relation Attributes: ^^^
+|reference |String |The reference that was defined for the Relation Type in the request document. |
+|relationId |String |Id of the Relationship.|
+**Examples:**
+<WRAP center round box 80%>
+An example of an AddItem request might use the following XML :
+<code><wxRequest>
+    <dataSet reference=”workxpress”>
+        <item itemTypeId=”a35234” />
+        <fields>
+            <field fieldId=”a66969”>
+                <value>WorkXpress</value>
+            </field>
+            <field fieldId=”a36314”>
+                <value>http://www.workxpress.com</value>
+            </field>
+        </fields>
+        <relations>
+            <relation action=”add” oppositeItemId=”u7436”
+reference=”account_to_contact”
+                relationType=”a36495” startingSide=”base”>
+                <fields>
+                    <field fieldId=”a36498”>
+                        <value>Developer</value>
+                    </field>
+                </fields>
+            </relation>
+        </relations>
+    </dataSet>
+</wxRequest> </code>
+</WRAP>
+<WRAP center round box 80%>
+Corresponding response XML:
+<code><wxResponse>
+    <callStatus status=”success” />
+    <compatibilityLevel>1</compatibilityLevel>
+    <dataSet reference=”workxpress”>
+        <item itemId=”u7563” itemTypeId=”a35234”>
+            <relation reference=”account_to_contact” relationId=”u7564”
+/>
+        </item>
+    </dataSet>
+</wxRequest> </code>
+</WRAP>
 ===== Function: UpdateItem =====
@@ Line 356: / Line 447: @@
 ^dataSet Attributes:^^^
 |reference |String |An identifier that will be returned with the response to identify different data sets. |
-|action |String  |The operation to perform on the Item.  Valid values are
+|action |String  |The operation to perform on the Item.  Valid values are:|
-delete – Deleted Items are completely removed from WorkXpress and cannot be
+| ::: | ::: |delete – Deleted Items are completely removed from WorkXpress and cannot be retrieved.  |
-retrieved.  recycle – Recycled Items are not removed from WorkXpress and can be
+| ::: | ::: |recycle – Recycled Items are not removed from WorkXpress and can be restored. restore – Restores a previously recycled item. |
-restored. restore – Restores a previously recycled item. update – Updates an
+| ::: | ::: |update – Updates an existing Item.|
-existing Item.|
 **<items></items>** - Contained inside of the dataSet node, the items node contains
@@ Line 369: / Line 459: @@
 ^item Attributes:^^^
-|itemId |String |The id of the Item to perform
+|itemId |String |The id of the Item to perform the operation on |
-the operation on |
 **<map></map>** - Contained inside of the items node, the map node contains the
@@ Line 396: / Line 485: @@
 node is the parent node for any Relationships that should be added or updated.
-**<relation></relation>** - Contained inside of the relations node, the relation node
+**<relation></relation>** - Contained inside of the relations node, the relation node defines a single Relation to add or update.
-defines a single Relation to add or update.
 ^relation Attributes:^^^
-|action |String |The action to perform on the
+|action |String |The action to perform on the Relationship.  Valid values are: |
-Relationship.  Valid values are:
+| ::: | ::: |add – Creates a new Relationship.|
+| ::: | ::: |update – Updates an existing Relationship.|
+| ::: | ::: |delete – Deleted Relationships are completely removed from WorkXpress and cannot be retrieved.|
+| ::: | ::: |recycle – Recycled Relationships are not removed from WorkXpress and can be restored.|
+| ::: | ::: |restore – Restores a previously recycled Relationship. |
+|oppositeItemId |String |The Item Id of the Item that you wish to relate the Item you are updating to.  If the action is not set to add, this will be used to find an existing Relationship. |
+|reference |String |An identifier that will be returned with the response to identify each Relationship that was created or updated. |
+|relationType |String |Id of the Relation Type you would like to create. |
+|startingSide |String |Defines which side of the Relation the Item being updated will be on.  Valid values are:|
+| ::: | ::: |base – The Item will be on the base side.|
+| ::: | ::: |target – The Item will be on the target side. |
-add – Creates a new
+**Response XML** - Below is a description of the valid nodes returned in the Response XML from an UpdateItem request.
-Relationship.
-update – Updates an existing
-Relationship.
-delete – Deleted
-Relationships are completely
-removed from WorkXpress
-and cannot be retrieved.
-recycle – Recycled
-Relationships are not
-removed from WorkXpress
-and can be restored.
-restore – Restores a
-previously recycled
-Relationship. |
-|oppositeItemId |String |The Item Id of the Item that
-you wish to relate the Item
-you are updating to.  If the
-action is not set to add, this
-will be used to find an
-existing Relationship. |
-|reference |String |An identifier that will be
-returned with the response to
-identify each Relationship
-that was created or updated. |
-|relationType |String |Id of the Relation Type you
-would like to create. |
-|startingSide |String |Defines which side of the
-Relation the Item being
-updated will be on.  Valid
-values are:
-base – The Item will be on
-the base side.
-target – The Item will be on
-the target side. |
-**Response XML** - Below is a description of the valid nodes returned in the Response
-XML from an UpdateItem request.
 **<wxResponse></wxResponse>** - The root node for the Response XML document.
@@ Line 464: / Line 519: @@
 ^dataSet Attributes:^^^
-|reference |String |The reference that was defined for the data set in the request
+|reference |String |The reference that was defined for the data set in the request document. |
-document. |
 **<item></item>** - Contained inside of the dataSet node, defines an Item that was
@@ Line 477: / Line 531: @@
 ^relation Attributes:^^^
-|Reference |String |The reference that was defined for the Relation in the request
+|Reference |String |The reference that was defined for the Relation in the request document. |
-document. |
 |relationId |String |Id of the Relationship. |
 **Examples:**
-//An example of a basic UpdateData request might use the following XML ://
-<WRAP center round box 80%>
+<WRAP center round box 80%>//An example of a basic UpdateData request might use the following XML ://
-<code><wxRequest>
+<code>
     <dataSet action=”update” reference=”account”>
         <items>
@@ Line 510: / Line 563: @@
 </WRAP>
-//Corresponding response XML://
-<WRAP center round box 80%><code>
+<WRAP center round box 80%>//Corresponding response XML://<code>
 <wxResponse>
     <callStatus status=”success” />
@@ Line 599: / Line 652: @@
 **Examples:**
-//An example of a basic ExecuteAction request might use the following XML ://
+<WRAP center round box 80%>//An example of a basic ExecuteAction request might use the following XML ://
-<WRAP center round box 80%><code>
+<code>
 <wxResponse>
     <dataSet reference=”accounts”>
@@ Line 615: / Line 668: @@
-//Corresponding response XML://
+<WRAP center round box 80%>//Corresponding response XML://
-<WRAP center round box 80%><code>
+<code>
 <wxResponse>
     <callStatus status=”success” />
@@ Line 637: / Line 690: @@
 the clean version of the map definition that must be used in any API call.
-{{ :map_builder.gif?nolink |}}
+{{ :map_builder.gif?nolink&500 |}}
 ====== Action: Third Party Web Service ======
@@ Line 651: / Line 704: @@
 such as strings, numbers and booleans.
-{{ :third_party_web_service.gif?nolink |}}
+{{ :third_party_web_service.gif?nolink&500 |}}

api.txt · Last modified: 2016/09/14 18:19 (external edit)

Show page Old revisions

Recent Changes Sitemap Back to top