Jump to

• Request
• Response
• Examples

Add API

post

/mobile/tools/1.0/apis

Creates an API definition.

Request

Supported Media Types

• application/json

Body ()

The API representation for POST requests.

Root Schema : apiCreate

Type: object

The API representation for POST requests.

Match All

Show Source

• object assetCreate
  The asset representation for POST requests.
• object apiCreate-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetCreate"
        },
        {
            "properties":{
                "apiDefn":{
                    "$ref":"#/definitions/stringArray"
                },
                "security":{
                    "$ref":"#/definitions/apiSecurity"
                },
                "basePath":{
                    "description":"The API base path in the format `/mobile/custom/{apiName}`. This is required to define the API name.",
                    "type":"string"
                },
                "hasBusinessObjects":{
                    "default":false,
                    "description":"Indicates whether the API is associated with API Express resources (business objects).",
                    "type":"boolean"
                },
                "icon":{
                    "$ref":"#/definitions/icon"
                },
                "businessObjectsDefn":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The API representation for POST requests.",
    "type":"object",
    "required":[
        "basePath",
        "title",
        "version",
        "desc"
    ]
}

Nested Schema : assetCreate

Type: object

The asset representation for POST requests.

Match All

Show Source

• object assetUpdate
  The asset representation for PUT requests.
• object assetCreate-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "properties":{
                "max":{
                    "default":false,
                    "type":"boolean"
                }
            }
        }
    ],
    "description":"The asset representation for POST requests.",
    "type":"object",
    "required":[
        "name"
    ]
}

Nested Schema : apiCreate-allOf[1]

Type: object

Show Source

• apiDefn: array stringArray
  Minimum Number of Items: 0

  An array of string values.
• basePath: string
  The API base path in the format `/mobile/custom/{apiName}`. This is required to define the API name.
• businessObjectsDefn: string
• hasBusinessObjects: boolean
  Default Value: false

  Indicates whether the API is associated with API Express resources (business objects).
• icon: object icon
  Information about the icon that's associated with the API or connector.
• security: object apiSecurity
  The API security for POST and PUT requests.

{
    "properties":{
        "apiDefn":{
            "$ref":"#/definitions/stringArray"
        },
        "security":{
            "$ref":"#/definitions/apiSecurity"
        },
        "basePath":{
            "description":"The API base path in the format `/mobile/custom/{apiName}`. This is required to define the API name.",
            "type":"string"
        },
        "hasBusinessObjects":{
            "default":false,
            "description":"Indicates whether the API is associated with API Express resources (business objects).",
            "type":"boolean"
        },
        "icon":{
            "$ref":"#/definitions/icon"
        },
        "businessObjectsDefn":{
            "type":"string"
        }
    }
}

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Show Source

• actionComment: string
• desc: string
  Maximum Length: 100
• max: boolean
  Default Value: false
• name: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
• namespace: string
  Applicable to APIs and implementations only. This value is null for all other asset types.
• title: string
  Maximum Length: 255
• version: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"The asset representation for PUT requests.",
    "type":"object",
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        },
        "namespace":{
            "description":"Applicable to APIs and implementations only. This value is null for all other asset types.",
            "type":"string"
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "maxLength":100
        },
        "title":{
            "type":"string",
            "maxLength":255
        },
        "version":{
            "$ref":"#/definitions/version"
        },
        "actionComment":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "maxLength":100
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : assetCreate-allOf[1]

Type: object

Show Source

• max: boolean
  Default Value: false

{
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        }
    }
}

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Show Source

• [0]: string

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of string values.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : icon

Type: object

Information about the icon that's associated with the API or connector.

Show Source

• id: string
• url: string

{
    "description":"Information about the icon that's associated with the API or connector.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "url":{
            "type":"string"
        }
    },
    "required":[
        "id",
        "url"
    ]
}

Nested Schema : apiSecurity

Type: object

The API security for POST and PUT requests.

Show Source

• access: object securityAccess
  Access details.
• endpoints: array endpointSecurityArray
  Minimum Number of Items: 0

  An array of endpoint security elements.
• loginType:
  Allowed Values: [ "ENTERPRISE", "IDENTITYPROVIDER" ]

  If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.
• required: boolean
  When `true`, either security access or a social identity provider configuration is required.

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "endpoints":{
            "$ref":"#/definitions/endpointSecurityArray"
        },
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "loginType":{
            "description":"If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.",
            "enum":[
                "ENTERPRISE",
                "IDENTITYPROVIDER"
            ]
        },
        "required":{
            "description":"When `true`, either security access or a social identity provider configuration is required.",
            "type":"boolean"
        }
    },
    "required":[
        "required"
    ]
}

Nested Schema : securityAccess

Type: object

Access details.

Show Source

• all: boolean
• roles: array stringArray
  Minimum Number of Items: 0

  An array of string values.

{
    "description":"Access details.",
    "type":"object",
    "properties":{
        "all":{
            "type":"boolean"
        },
        "roles":{
            "$ref":"#/definitions/stringArray"
        }
    }
}

Nested Schema : endpointSecurityArray

Type: array

Minimum Number of Items: 0

An array of endpoint security elements.

Show Source

• [0]: object endpointSecurity
  The API security for POST and PUT requests.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of endpoint security elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/endpointSecurity"
    }
}

Nested Schema : endpointSecurity

Type: object

The API security for POST and PUT requests.

Show Source

• access: object securityAccess
  Access details.
• method: string
• resource: string

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "method":{
            "type":"string"
        },
        "resource":{
            "type":"string"
        }
    },
    "required":[
        "method",
        "resource"
    ]
}

Response

Supported Media Types

• application/json

201 Response

The API was created, and the metadata for the new API was returned.

Headers

• ETag: string
  The ETag corresponds to the state of the API (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.
• Location: string
  URL to get the details about the new APIs.

Body ()

Information about the API (short form) and the RAML-validation result. This information doesn't include the RAML descriptor.

Root Schema : apiCreatedWithRamlValidation

Type: object

Information about the API (short form) and the RAML-validation result. This information doesn't include the RAML descriptor.

Match All

Show Source

• object apiShort
  The short API definition representation.
• object apiCreatedWithRamlValidation-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/apiShort"
        },
        {
            "properties":{
                "security":{
                    "$ref":"#/definitions/apiSecurity"
                },
                "ramlValidationReport":{
                    "$ref":"#/definitions/ramlValidationReport"
                }
            }
        }
    ],
    "description":"Information about the API (short form) and the RAML-validation result. This information doesn't include the RAML descriptor.",
    "type":"object",
    "required":[
        "basePath",
        "name",
        "links",
        "id",
        "published",
        "title",
        "version"
    ]
}

Nested Schema : apiShort

Type: object

The short API definition representation.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.
• object apiShort-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "basePath":{
                    "description":"The API base path in the format `/mobile/custom/{apiName}`.",
                    "type":"string"
                },
                "hasBusinessObjects":{
                    "default":false,
                    "description":"Indicates whether the API is associated with API Express resources (business objects).",
                    "type":"boolean"
                },
                "icon":{
                    "$ref":"#/definitions/icon"
                }
            }
        }
    ],
    "description":"The short API definition representation.",
    "type":"object",
    "required":[
        "basePath",
        "name",
        "links",
        "id",
        "published",
        "title",
        "version"
    ]
}

Nested Schema : apiCreatedWithRamlValidation-allOf[1]

Type: object

Show Source

• ramlValidationReport: object ramlValidationReport
  The result of the RAML validation.
• security: object apiSecurity
  The API security for POST and PUT requests.

{
    "properties":{
        "security":{
            "$ref":"#/definitions/apiSecurity"
        },
        "ramlValidationReport":{
            "$ref":"#/definitions/ramlValidationReport"
        }
    }
}

Nested Schema : assetGet

Type: object

The asset representation for GET requests.

Match All

Show Source

• object assetUpdate
  The asset representation for PUT requests.
• object assetIdEtag
  The asset ID and entity tag (ETag) values.
• object trash
  Indicator of whether the asset is in the trash.
• object assetGet-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "$ref":"#/definitions/assetIdEtag"
        },
        {
            "$ref":"#/definitions/trash"
        },
        {
            "properties":{
                "modifiedOn":{
                    "type":"string"
                },
                "deletedOn":{
                    "type":"string"
                },
                "modifiedBy":{
                    "type":"string"
                },
                "links":{
                    "$ref":"#/definitions/entityLinksArray"
                },
                "published":{
                    "description":"An asset draft or published status representation.",
                    "type":"boolean"
                },
                "createdOn":{
                    "type":"string"
                },
                "deletedBy":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The asset representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : apiShort-allOf[1]

Type: object

Show Source

• basePath: string
  The API base path in the format `/mobile/custom/{apiName}`.
• hasBusinessObjects: boolean
  Default Value: false

  Indicates whether the API is associated with API Express resources (business objects).
• icon: object icon
  Information about the icon that's associated with the API or connector.

{
    "properties":{
        "basePath":{
            "description":"The API base path in the format `/mobile/custom/{apiName}`.",
            "type":"string"
        },
        "hasBusinessObjects":{
            "default":false,
            "description":"Indicates whether the API is associated with API Express resources (business objects).",
            "type":"boolean"
        },
        "icon":{
            "$ref":"#/definitions/icon"
        }
    }
}

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Show Source

• actionComment: string
• desc: string
  Maximum Length: 100
• max: boolean
  Default Value: false
• name: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
• namespace: string
  Applicable to APIs and implementations only. This value is null for all other asset types.
• title: string
  Maximum Length: 255
• version: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"The asset representation for PUT requests.",
    "type":"object",
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        },
        "namespace":{
            "description":"Applicable to APIs and implementations only. This value is null for all other asset types.",
            "type":"string"
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "maxLength":100
        },
        "title":{
            "type":"string",
            "maxLength":255
        },
        "version":{
            "$ref":"#/definitions/version"
        },
        "actionComment":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "maxLength":100
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : assetIdEtag

Type: object

The asset ID and entity tag (ETag) values.

Show Source

• etag: string
  The asset entity tag (ETag) value, which you can use to detect concurrent modification.
• id: string

{
    "description":"The asset ID and entity tag (ETag) values.",
    "type":"object",
    "properties":{
        "etag":{
            "description":"The asset entity tag (ETag) value, which you can use to detect concurrent modification.",
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Show Source

• inTrash: boolean

{
    "description":"Indicator of whether the asset is in the trash.",
    "type":"object",
    "properties":{
        "inTrash":{
            "type":"boolean"
        }
    }
}

Nested Schema : assetGet-allOf[3]

Type: object

Show Source

• createdOn: string
• deletedBy: string
• deletedOn: string
• links: array entityLinksArray
  Minimum Number of Items: 0

  An array of links for an entity's metadata.
• modifiedBy: string
• modifiedOn: string
• published: boolean
  An asset draft or published status representation.

{
    "properties":{
        "modifiedOn":{
            "type":"string"
        },
        "deletedOn":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/entityLinksArray"
        },
        "published":{
            "description":"An asset draft or published status representation.",
            "type":"boolean"
        },
        "createdOn":{
            "type":"string"
        },
        "deletedBy":{
            "type":"string"
        }
    }
}

Nested Schema : entityLinksArray

Type: array

Minimum Number of Items: 0

An array of links for an entity's metadata.

Show Source

• [0]: object items
  Link to the entity's metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for an entity's metadata.",
    "type":"array",
    "items":{
        "description":"Link to the entity's metadata.",
        "type":"object",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : items

Type: object

Link to the entity's metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical" ]

  Link type.

{
    "description":"Link to the entity's metadata.",
    "type":"object",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Nested Schema : icon

Type: object

Information about the icon that's associated with the API or connector.

Show Source

• id: string
• url: string

{
    "description":"Information about the icon that's associated with the API or connector.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "url":{
            "type":"string"
        }
    },
    "required":[
        "id",
        "url"
    ]
}

Nested Schema : ramlValidationReport

Type: object

The result of the RAML validation.

Show Source

• valid: boolean
• validationResults: array validationResults
  Minimum Number of Items: 0

{
    "description":"The result of the RAML validation.",
    "type":"object",
    "properties":{
        "valid":{
            "type":"boolean"
        },
        "validationResults":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "valid"
    ]
}

Nested Schema : apiSecurity

Type: object

The API security for POST and PUT requests.

Show Source

• access: object securityAccess
  Access details.
• endpoints: array endpointSecurityArray
  Minimum Number of Items: 0

  An array of endpoint security elements.
• loginType:
  Allowed Values: [ "ENTERPRISE", "IDENTITYPROVIDER" ]

  If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.
• required: boolean
  When `true`, either security access or a social identity provider configuration is required.

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "endpoints":{
            "$ref":"#/definitions/endpointSecurityArray"
        },
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "loginType":{
            "description":"If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.",
            "enum":[
                "ENTERPRISE",
                "IDENTITYPROVIDER"
            ]
        },
        "required":{
            "description":"When `true`, either security access or a social identity provider configuration is required.",
            "type":"boolean"
        }
    },
    "required":[
        "required"
    ]
}

Nested Schema : validationResults

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

{
    "minItems":0,
    "uniqueItems":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : securityAccess

Type: object

Access details.

Show Source

• all: boolean
• roles: array stringArray
  Minimum Number of Items: 0

  An array of string values.

{
    "description":"Access details.",
    "type":"object",
    "properties":{
        "all":{
            "type":"boolean"
        },
        "roles":{
            "$ref":"#/definitions/stringArray"
        }
    }
}

Nested Schema : endpointSecurityArray

Type: array

Minimum Number of Items: 0

An array of endpoint security elements.

Show Source

• [0]: object endpointSecurity
  The API security for POST and PUT requests.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of endpoint security elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/endpointSecurity"
    }
}

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Show Source

• [0]: string

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of string values.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : endpointSecurity

Type: object

The API security for POST and PUT requests.

Show Source

• access: object securityAccess
  Access details.
• method: string
• resource: string

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "method":{
            "type":"string"
        },
        "resource":{
            "type":"string"
        }
    },
    "required":[
        "method",
        "resource"
    ]
}

400 Response

The API metadata is missing information (for example, the API specification is missing) or it has incorrect data (the RAML can't be parsed). In the case of an incorrect RAML, send a request to POST /apis/raml to get RAML validation details.

Body ()

Root Schema : error

Type: object

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

409 Response

An API with the same name and version already exists.

Body ()

Root Schema : error

Type: object

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

Examples

The following example shows how to add an API using cURL. For more information about cURL, see Use cURL.

curl -i -X POST -d @body.json -H "Content-Type: application/json; charset=utf-8" -H "Authorization: Bearer $TOKEN" "$BASE_URL/mobile/tools/1.0/apis"

Example of Request Body

The following shows an example of a request body that contains the required properties, which are version, desc, and apiDefn. The values were obtained from the response body of a POST /mobile/tools/1.0/apis/raml request.

{
    "version": "1.0",
    "desc": "Message of the Day API",
    "apiDefn": [
        "#%RAML 0.8\r",
        "title: Message of the Day\r",
        "version: 1.0\r",
        "baseUri: /mobile/custom/motd\r",
        "schemas:\r",
        "  - motd: | \r",
        "      {\r",
        "        \"id\": \"motd\",\r",
        "        \"$schema\": \"http://json-schema.org/draft-04/schema#\",\r",
        "        \"title\": \"The message of the day.\",\r",
        "        \"type\": \"object\",\r",
        "        \"properties\": {\r",
        "          \"message\": {\r",
        "            \"description\":\"The message string.\",\r",
        "            \"type\": \"string\"\r",
        "          }\r",
        "        }\r",
        "      }\r",
        "           \r",
        "/motd:\r",
        "  description: \"Message to display on the home page.\"\r",
        "  get:\r",
        "    description: \"Returns the message of the day.\"\r",
        "    responses:\r",
        "      200:\r",
        "        description: \"The information was retrieved successfully.\"\r",
        "        body: \r",
        "          application/json: \r",
        "            schema: motd\r",
        "            example: | \r",
        "              {\r",
        "                \"message\": \"Happy Monday!\"\r",
        "              }"
    ]
}

Example of Response Header

The following shows an example of the response headers:

200 CREATED
Content-Length: 1700
Content-Type: application/json
Date: Thurs, 19 Oct 2017 23:56:59 GMT
Etag: "1"

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "id": "1f014f2f-700c-4ef9-889a-4be803923720",
    "namespace": "custom",
    "name": "motd",
    "version": "1.0",
    "desc": "Message of the Day API",
    "links": [
        {
            "rel": "canonical",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720"
        },
        {
            "rel": "purgeDependencies",
            "href": "/mobile/tools/1.0/assets/purgeDependencies"
        },
        {
            "rel": "purging",
            "href": "/mobile/tools/1.0/assets/purging"
        },
        {
            "rel": "trashDependencies",
            "href": "/mobile/tools/1.0/assets/trashDependencies"
        },
        {
            "rel": "trashing",
            "href": "/mobile/tools/1.0/assets/trashing"
        },
        {
            "rel": "untrashDependencies",
            "href": "/mobile/tools/1.0/assets/untrashDependencies"
        },
        {
            "rel": "untrashing",
            "href": "/mobile/tools/1.0/assets/untrashing"
        },
        {
            "rel": "dependencies",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720/dependencies"
        },
        {
            "rel": "history",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720/history"
        },
        {
            "rel": "publication",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720/publication"
        },
        {
            "rel": "reverseDependencies",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720/reverseDependencies"
        },
        {
            "rel": "implementations",
            "href": "/mobile/tools/1.0/apis/1f014f2f-700c-4ef9-889a-4be803923720/implementations"
        },
        {
            "rel": "self",
            "href": "/mobile/tools/1.0/apis"
        }
    ],
    "published": false,
    "inTrash": false,
    "actionComment": null,
    "etag": "1",
    "createdOn": "2017-10-04T23:57:02.026Z",
    "modifiedOn": "2017-10-04T23:57:02.026Z",
    "modifiedBy": "jdoe",
    "deletedOn": null,
    "deletedBy": null,
    "title": "Message of the Day",
    "basePath": "/mobile/custom/motd",
    "icon": null,
    "category": "CUSTOM",
    "hasBusinessObjects": false,
    "ramlValidationReport": {
        "validationResults": [],
        "valid": true
    },
    "security": {
        "required": false,
        "loginType": null,
        "access": null,
        "endpoints": []
    }
}