GET data/{name}/{recordId}
Gets a record using the default section layout.
Request Information
URI
https://ofd-api.blueprintcpq.net/data/{name}/{recordId}?fields[0]={fields[0]}&fields[1]={fields[1]}&share={share}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name |
Page name. |
string |
Required |
recordId |
Record Identifier. |
string |
Required |
fields |
Fields to include |
Collection of string |
Required |
share |
Optional share parameter |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
Section Data.
SectionDataName | Description | Type | Additional information |
---|---|---|---|
Section | string |
None. |
|
Locked | boolean |
None. |
|
Data | Collection of DataValue |
None. |
Response Formats
application/json, text/json
Sample:
{ "Section": "sample string 1", "Locked": true, "Data": [ { "Field": "d9082bfe-8a19-4642-ad35-dc2f4a193ce5", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} }, { "Field": "d9082bfe-8a19-4642-ad35-dc2f4a193ce5", "FieldName": "sample string 2", "Locked": true, "Component": "sample string 4", "Value": {}, "HumanReadableValue": {} } ] }
text/html
Sample:
{"Section":"sample string 1","Locked":true,"Data":[{"Field":"d9082bfe-8a19-4642-ad35-dc2f4a193ce5","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"d9082bfe-8a19-4642-ad35-dc2f4a193ce5","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]}
application/xml, text/xml
Sample:
<SectionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels"> <Data> <DataValue> <Component>sample string 4</Component> <Field>d9082bfe-8a19-4642-ad35-dc2f4a193ce5</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> <DataValue> <Component>sample string 4</Component> <Field>d9082bfe-8a19-4642-ad35-dc2f4a193ce5</Field> <FieldName>sample string 2</FieldName> <HumanReadableValue /> <Locked>true</Locked> <Value /> </DataValue> </Data> <Locked>true</Locked> <Section>sample string 1</Section> </SectionData>