Jump to

• Request
• Response

Add Custom Content

post

/content/sim/v1/setup/customContent

Add the custom content to the specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Request body

Root Schema : CustomContentInsertRequestBody

Type: object

Show Source

• description(required): object TranslatedString_description
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the description of custom content in configured languages
• filename: string
  The name of the custom content file with extension

  Example: ImageSpoons.jpg
• filenameOrigin: string
  the content file origin.

  Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• name(required): string
  The name of the content object

  Example: Image Spoons
• size: integer
  the size of the custom content in bytes.

  Example: Size: 12 kb, png: 100 x 100 px
• target: string
  A string value of 0???s & 1???s representing the platforms where the content is targeted

  Example: 11111111111111111111111111111111
• type(required): integer
  The file type for the custom content

  Example: 9

{
    "type":"object",
    "required":[
        "hierUnitId",
        "name",
        "description",
        "type"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "name":{
            "type":"string",
            "example":"Image Spoons",
            "description":"The name of the content object"
        },
        "description":{
            "$ref":"#/definitions/TranslatedString_description"
        },
        "size":{
            "type":"integer",
            "example":"Size: 12 kb, png: 100 x 100 px",
            "description":"the size of the custom content in bytes."
        },
        "type":{
            "type":"integer",
            "example":9,
            "description":"The file type for the custom content"
        },
        "filenameOrigin":{
            "type":"string",
            "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll",
            "description":"the content file origin."
        },
        "target":{
            "type":"string",
            "example":"11111111111111111111111111111111",
            "description":"A string value of 0???s & 1???s representing the platforms where the content is targeted"
        },
        "filename":{
            "type":"string",
            "example":"ImageSpoons.jpg",
            "description":"The name of the custom content file with extension"
        }
    }
}

Nested Schema : TranslatedString_description

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the description of custom content in configured languages",
    "type":"object",
    "example":{
        "en-US":"Image Spoons",
        "de-DE":"Bild L??ffel",
        "es-MX":"Cucharas de Imagen"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the description of custom content in configured languages

Example:

{
    "en-US":"Image Spoons",
    "de-DE":"Bild L??ffel",
    "es-MX":"Cucharas de Imagen"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object

Body ()

Root Schema : CustomContentResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value.

  Example: 1
• id(required): integer
  Unique reference of the content

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "id"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "id":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the content"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top