Values

Get values

get

/values/

This api is used to get values from OutSmart.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

val_entitystringOptionalExample: WORKORDER

val_primaryintegerOptionalExample: 24

val_columnstringOptionalExample: id

Responses

200

Get values

application/json

get/values/

GET /values/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Get values

{
  "code": 200,
  "messages": [],
  "response": {
    "val_id": "1150",
    "val_cus_id": "78",
    "val_entity": "CLIENT",
    "val_primary": "24",
    "val_primary_numeric": "24"
  }
}

Add values

post

/values/

This api is used to sync values with OutSmart.

The following paramters can be posted as key value form-data

Parameter	Required	Description
val_entity	Y	One off: WORKORDER,OBJECT_PART,CLIENT,PROJECT,OBJECT,INVOICE,QUOTATION,CONTACTPERSON,ADDRESS,MATERIAL,HOUR,WORKORDER_MATERIAL,WORKORDER_HOUR
val_column	Y	The column that is used as a reference
val_primary	Y	Unique identifier for entity based on colum
val_value_1 - val_value_50	Y	Freefield that should be updated

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tokenstringOptionalExample: {{client_token}}

software_tokenstringOptionalExample: {{software_token}}

Responses

200

Error

application/json

post/values/

POST /values/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Error

{
  "code": 1007,
  "messages": [],
  "response": "val_primary not found for Reference with value 40 for entity WORKORDER"
}