Entity - Fragments

Minimum API version 4.0

VerbRequestNotesPermission required
GET/Consumer/FragmentsReturns all fragmentsRequires 'Read' permission on 'GuaranteedState' securable type
GET/Consumer/Fragments/{id}Returns a single fragment by its IdRequires 'Read' permission on 'GuaranteedState' securable type
GET/Consumer/Fragments/Shallow/All

Minimum API version 5.1

Returns all fragments but without their respective Payloads.

Requires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Fragments/Search

Returns Fragments that match the search parameters specified

Allowed filter columns:

  • Name
  • Type
  • ReadablePayload

Allowed sort columns:

  • Name
  • Type
Requires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Fragments/Shallow/Search

Returns Fragments that match the search parameters specified.

Fragment's payload will not be returned. If you require payload please use /Fragments/Search instead.

Allowed filter columns:

  • Name
  • Type
  • ReadablePayload

Allowed sort columns:

  • Name
  • Type
Requires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Fragments

Unavailable from version 5.1 onwards

Creates a new Fragment

Requires 'Write' permission on 'GuaranteedState' securable type
PUT/Consumer/Fragments

Unavailable from version 5.1 onwards

Modifies an existing Fragment

Requires 'Write' permission on 'GuaranteedState' securable type
POST/Consumer/Fragments/UploadFile

Minimum API version 5.1

Uploads a Fragment file

Payload must be sent as multipart form data with the file attached.
File must be sent within a boundary. Omitting the boundary will cause the upload to fail.
Any boundary can be used as long as it is specified within the call itself.

If you wanted to upload an image called 'somefile.xml', you could, for example, use 'xyzzy' as a boundary.
Then you would add this line:

Content-Type: multipart/form-data; boundary=xyzzy

And the payload would look something like this:

--xyzzy
Content-Disposition: form-data; name="somefile.xml"; filename="somefile.xml"
Content-Type: text/xml

{the contents of the file goes here}
--xyzzy--

Requires 'Write' permission on 'GuaranteedState' securable type
DELETE/Consumer/Fragments/{id}Deletes a FragmentRequires 'Delete' permission on 'GuaranteedState' securable type
GET/Consumer/Fragments/Export/Id/{id}

Minimum API version 5.1

Exports a Fragment as an Xml file

Requires 'Read' permission on 'GuaranteedState' securable type
GET/Consumer/Fragments/Export/Name/{name}

Minimum API version 5.1

Exports a Fragment as an Xml file

Requires 'Read' permission on 'GuaranteedState' securable type