Upsert Extension Applications

post

/config/sim/v2/setup/upsertExtensionApplications

Updates provided fields if the Extension Application exists; inserts a new Extension Application if it does not.

Request

Supported Media Types
Header Parameters
Body ()
Extension Application upsert request body.
Root Schema : schema
Type: object
Show Source
  • allowedAccessPaths
    Allowed access paths for the Extension Application. Supported from Simphony 19.10.1 onwards.
  • Default Value: 2
    Data level. Valid range is 0 to 2 and cannot be set to null.
    Example: 2
  • description
    A group of string objects representing the description in configured languages. Can be null or empty.
  • Unique reference of the Extension Application. Auto-generated on insert and required for updates through upsert.
    Example: 101
  • Unique hierarchy unit value.
    Example: 3599
  • Interface identifier. When specified, it must be a valid interface id.
    Example: 10
  • Default Value: 200
    Maximum characters allowed. Valid range is 1 to 2000 and cannot be set to null.
    Example: 200
  • Default Value: 1
    Maximum items allowed. Valid range is 1 to 100 and cannot be set to null.
    Example: 1
  • Name of the Extension Application. Required for inserts through upsert. When specified, it must be 1-200 characters, unique within the hierarchy unit, and cannot be set to null.
    Example: Loyalty Extension
  • Default Value: 0000000000000000000000000000000000000000000000000000000000000000
    Bit string of length 64 representing the Extension Application options.
    Example: 0000000000000000000000000000000000000000000000000000000000000000
  • Default Value: 0
    Type of the Extension Application. Valid range is 0 to 2.
    Example: 0
Nested Schema : allowedAccessPaths
Type: array
Allowed access paths for the Extension Application. Supported from Simphony 19.10.1 onwards.
Show Source
Example:
[
    "C://Simphony"
]
Nested Schema : description
Type: object
A group of string objects representing the description in configured languages. Can be null or empty.
Example:
{
    "1":"Loyalty Extension",
    "2":"Loyalty Extension"
}
Back to Top

Response

Supported Media Types

200 Response

Extension Application updated.
Body ()
Root Schema : schema
Type: object
Show Source

201 Response

Extension Application inserted.
Body ()
Root Schema : schema
Type: object
Show Source
Back to Top