Holds entity data such as entity ID, entity type ID, and pairs of field IDs and values. Is used as
input and return object.
EntityObj contains three elements:
entityID
- (Optional) The ID of the specific entity instance. Not required if you are creating an entity.
entityTypeID
- The ID that corresponds to the entity type (for example, project, resource, task). You can
find entity type IDs on Admin>Web Services API in the Innotas app.
methodValues
- Pairs of field (method) values and their corresponding IDs. When inserting/updating/creating an entity,
you need to know and include the required fields. You can determine required
fields by going to Admin>Web Services API and clicking the Fields link for any entity. Required fields are listed for each mode.
The following is an example of an EntityObj for creating a project (not all required fields are represented). The entityId
element is empty, because this example is for creating a new entity. If the object was holding returned data, there
would be a value for entityId. The EntityObj is not used on its own, but is wrapped in a
createOrReplace
call.
<ser:newObj>
<xsd:entityId>?</xsd:entityId>
<xsd:entityTypeId>4</xsd:entityTypeId>
<xsd:methodValues>
<xsd:elementValue>MyNewProjectTitle</xsd:elementValue>
<xsd:id>436</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>8826911</xsd:elementValue>
<xsd:id>414</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>Rose, Jennifer</xsd:elementValue>
<xsd:id>416</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>Program ID</xsd:elementValue>
<xsd:id>423</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>ProgramName</xsd:elementValue>
<xsd:id>425</xsd:id>
</xsd:methodValues>
</ser:newObj>