Platform API

<back to all web services

SaveDimensionValue

Add or update a dimension values details.

Requires Authentication
The following routes are available for this service:
PUT/api/dimensionvalues/{DimensionValueId}
POST/api/dimensionvalues
SaveDimensionValue Parameters:
NameParameterData TypeRequiredDescription
DimensionValuebodyDimensionValueModelYesDetails of the dimension value to be added or updated.
DimensionValueIdpathGuidYesId of the dimension value.
DimensionValueModel Parameters:
NameParameterData TypeRequiredDescription
DimensionValueIdbodyGuidNoId of the dimension value.
DimensionIdbodyGuidNoDimension Id this value is for.
NamebodystringNoName of the dimension value.
DescriptionbodystringNoDescription of the dimension value.
ShortNamebodystringNoShort Name for the dimension value.
TrafficLightIdbodyGuidNoId of the colour associated.
TrafficLightColourbodystringNoColour associated with the dimension value.
ObjectConnectionIdbodyGuidNoId that links this dimension value to an object.
OwnerContactIdbodyGuidNoOwner Id of the dimension value.
RecordStatusbodystringNoRecord status of the dimension value.
SaveDimensionValueResponse Parameters:
NameParameterData TypeRequiredDescription
DimensionValueIdqueryGuidNoId of the Dimension Value created.
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DimensionValue":{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"DimensionValueId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DimensionValueId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}