Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.0.0

The FlexAttribute API is used to create, update or delete flex attribute definitions. A flex attribute is a custom data input field that is used to collect additional information that was not originally designed into the mobile application.


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel1

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

/seiapi/v3/trans/FlexAttribute/${FlexAttrID}

API Specific Parameters

ParameterDescription

${FlexAttrID}

Identifies the unique flex attribute object.

Supported HTTP Methods

MethodDescription
GET

Returns the flex attribute definition identified by the ${FlexAttrID} URL parameter.

PUTCreates a new flex attribute definition identified by the ${FlexAttrID} URL parameter. If the flex attribute definition already exists and error will be returned.
POSTUpdates the existing flex attribute definition identified by the ${FlexAttrID} URL parameter.
DELETE

Deletes an existing flex attribute definition, identified by ${FlexAttrID} URL parameter. If the object does not exists or has been deleted, a soft warning is returned.

(info) A request body is not required for the DELETE method.

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Body

The body contains a single FlexAttr object in the format specified on the URL. 

Include Page
_FlexAttr Object Formats
_FlexAttr Object Formats

Include Page
_REST Response Codes
_REST Response Codes