Help Center

Integration and API

Data schema

Base

The following objects are included in the base model and are referenced throughout the various schema objects. It is therefore necessary to fully understand them.

XSD reference: http://app.progressionlive.com/static/ws/v1/base.xsd

Property	Type	Description
Id	long	Internal identifier in Progression
UID	string	Unique internal identifier in Progression (not used in every Record)
properties	ArrayOfProperty	List of properties. All customizable form properties are stored here. See Property.
metas	ArrayOfProperty	List of meta properties. Allows the storing of almost every kind of data in objects, but without being visible in the interface.
removed	datetime	Date/time of object deletion. Shows that the object has been deleted.

Record (or Object) in Progression

This is the base object from which most objects inherit.

Property	Type	Description
Id	long	Internal identifier in Progression
UID	string	Unique internal identifier in Progression (not used in every Record)
Type	RecordType	Type of Record
Label	string	Text description of Record. Sometimes used to reference certain types of Record objects without knowing their Id.
RecordRef – Points to a "Record"

Property

Type

Description

Value

String

List of possible values:

CIE

CLIENT

CLIENT_TYPE

DISPONIBILITY

HUMAN_RESOURCE

HUMAN_RESOURCE_TYPE

MOBILECONF

NODE

NODE_TYPE

PRODUCT

PRODUCT_IMAGE

PRODUCT_PRICE

PRODUCT_PRICE_LIST

PRODUCT_TYPE

PROPERTY_CONFIGURATION

PROPERTY_CONFIGURATIONS

PROPERTY_DEFINITION

PROPERTY_GROUP

PROPERTY_OPTIONS_LIST

RELATED_PRODUCT

RESOURCE

RESOURCE_TYPE

ROLE

TAG

TASK

TASK_ATTACHMENT

TASK_COMMENT

TASK_ITEM

TASK_ITEM_LIST

TASK_ITEM_TYPE

TASK_PRIORITY

TASK_SIGNATURE

TASK_STATE

TASK_TYPE

TAX

TAX_AMOUNT

TAX_CONFIG

USER

WORKFLOW

WORKFLOW_STEP

WORKFLOW_TRANSITION

RecordType - Type of "Record" (list)

Property

Type

Description

Property

List

Property List

ArrayOfProperty - List of Properties

Property	Type	Description
Name	string	Property Name
Value	anyType	Property Value. Must match the real type of the property’s definition.

Property

Type

Description

RecordRef

List

RecordRef List

ArrayOfRecordRef – List of RecordRef

Property

Type

Description

Record

List

List of Record. The real type depends on the property or operation performed.

ArrayOfRecord – List of Record

Property	Type	Description
Address	String	Address with civic number and street
City	String	City
Province	String	Province
Country	String	Country
PostalCode	String	Postal/Zip code
Position	Position	Geographic Position
Address – Civic Address

Property	Type	Description
Latitude	Double	Latitude
Longitude	Double	Longitude
Position – Geographic Position

Property	Type	Description
RecordField	List	List of RecordField to be updated
ArrayOfRecordField

Property	Type	Description
Name	string	Property Name
Value	anyType	Property Value. Must match the real type of the property’s definition.
Type	RecordFieldType	Type of property to be updated.
RecordField

Property

Type

Description

value

string

List of possible values:

FIELD // Static fields (ie.: Summary on Task)

PROPERTY // Customizable fields (properties)

META // Empty field (metas)

RecordFieldType – List of field types (for UpdateRecordField and UpdateRecordFields)