{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The idea behind REST configurations is to create a collection of HTTP requests that can be used in the pfx-rest component. This collection also predefines some common features of the target system, e.g. authentication mechanism, request headers etc.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Definition","type":"text"}]},{"type":"paragraph","content":[{"text":"REST configurations are represented in the XML format and are part of the configuration as a whole. This is a sample REST configuration:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n net.pricefx.integration.component.rest.domain.connection.OAuth2Connection\n \n {\"grant_type\": \"client_credentials\", \"client_id\": \"::clientId\", \"client_secret\":\n \"::clientSecret\", \"scope\": \"::scope\"}\n \n \n

\n OData-MaxVersion\n 4.0\n

\n OData-Version\n 4.0\n

\n Prefer\n return=representation\n

\n \n \n \n getRecords\n /api/data/{{apiVersion}}/{{recordType}}\n GET\n \n \n apiVersion\n \n \n recordType\n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Implementation Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"connection","type":"text","marks":[{"type":"code"}]},{"text":" part defines common connection fields for all configurations.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"authRequestTemplate","type":"text","marks":[{"type":"code"}]},{"text":" is defined, such definition will be set to the connection and have precedence over the connection setup.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can set up the elements ","type":"text"},{"text":"headers","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"connections","type":"text","marks":[{"type":"code"}]},{"text":" here instead of defining them for each configuration item.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rest","type":"text","marks":[{"type":"code"}]},{"text":" defines a single configuration which can be referenced.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"properties","type":"text","marks":[{"type":"code"}]},{"text":" define customizations to the ","type":"text"},{"text":"uri","type":"text","marks":[{"type":"code"}]},{"text":" parameter where the placeholder ","type":"text"},{"text":"{{}}","type":"text","marks":[{"type":"code"}]},{"text":" exists.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"method","type":"text","marks":[{"type":"code"}]},{"text":" defines the HTTP request method.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can also set up the elements ","type":"text"},{"text":"headers","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"connections","type":"text","marks":[{"type":"code"}]},{"text":" here for fine-graining.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"headers","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"connections","type":"text","marks":[{"type":"code"}]},{"text":" sections are defined both on the ","type":"text"},{"text":"rests","type":"text","marks":[{"type":"code"}]},{"text":" level and ","type":"text"},{"text":"rest","type":"text","marks":[{"type":"code"}]},{"text":" level, the result is merge of both definitions, where the ","type":"text"},{"text":"rest","type":"text","marks":[{"type":"code"}]},{"text":" level has precedence over ","type":"text"},{"text":"rests","type":"text","marks":[{"type":"code"}]},{"text":" regarding duplicate items.","type":"text"}]}]}]}],"version":1}

Browser not supported