Create a resource

post https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/resources

Creates a resource in an endpoint version. The resource's full URL (concatenated hostname, basePath, and resourcepath) needs to be unique within the account. You can only create resources for versions that have never been activated on the staging or production network.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists

array of strings

HTTP methods the resource may respond to.

apiResourceMethodNameLists

apiResourceMethods

array of objects

HTTP methods the resource may respond to.

apiResourceMethods

apiResourceName

string

required

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

The URL path relative to the hostnames on which the resource resides. When entering a resource path, you can use curly brackets ({}) to define path parameters (for example, /path/{pathparam}). If you decide to do so, ensure that the value of the apiParameterName member in the corresponding parameter definition matches the name that you specified in the resource path.

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

Response

Response body

object

apiResourceClonedFromId

integer | null

For cloned resources, the unique identifier for the source resource.

apiResourceId

integer

The unique identifier for the resource.

apiResourceLogicId

integer

The unique identifier for the resource across all endpoint versions.

apiResourceMethodNameLists

array of strings

HTTP methods the resource may respond to.

apiResourceMethodNameLists

apiResourceMethods

array of objects

HTTP methods the resource may respond to.

apiResourceMethods

object

apiParameters

array of objects | null

Parameter objects assigned to the method.

apiParameters

object

apiChildParameters

array of objects

Child JSON members or XML elements for JSON or XML body type parameters.

apiChildParameters

object

apiParamLogicId

integer

Read-only The unique identifier for the parameter across all endpoint versions.

apiParameterContentType

string

The content type of the parameter, either json, xml, json/xml for either, urlencoded, any, or none. Only applicable for top-level body parameters.

json xml json/xml urlencoded any none

apiParameterId

integer

Read-only The unique identifier for the parameter.

apiParameterLocation

string

required

The location of the parameter in an HTTP request, either query, header, path, cookie, or body for a JSON or XML body type parameter.

query header path cookie body

apiParameterName

string

required

The name of the parameter. If the corresponding apiParameterLocation is path, ensure that this value matches the parameter name you specified in the resourcePath.

apiParameterNotes

string | null

The description to clarify the parameter's function. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.

apiParameterRequired

boolean

required

Specifies whether the API user needs to specify the parameter. If the corresponding apiParameterLocation is path, set this member to true.

apiParameterRestriction

object | null

Restrictions and XML representation rules specified for the parameter.

apiParameterType

string

required

The data type of the parameter, either string, integer, number, boolean, or json/xml for JSON or XML objects.

string integer number boolean json/xml

apiResourceMethParamId

integer | null

Read-only The unique identifier for the parameter's parent method.

array

boolean

Whether the parameter can express more than one value. This member is only applicable for apiChildParameters that you can specify if the corresponding apiParameterLocation is body and the apiParameterType is json/xml. If you enable this, also define the arrayRestriction member.

pathParamLocationId

integer | null

The index of a segment that includes a path parameter in a resource path. For example, given a path \books\{bookId}, the books segment has index 0, and the path parameter {bookId} has index 1.

response

boolean

Whether the parameter is within a response type.

apiResourceMethod

string

required

The core HTTP method to which the resource may respond, either GET, PUT, POST, DELETE, HEAD, PATCH, or OPTIONS.

GET PUT POST DELETE HEAD PATCH OPTIONS

apiResourceMethodId

integer | null

Read-only The unique identifier for the resource's allowed method.

apiResourceMethodLogicId

integer | null

Read-only The unique identifier for the resource's method across all endpoint versions.

apiResourceName

string

required

The name of the resource.

createDate

date-time

The ISO 8601 timestamp indicating when you created the resource.

createdBy

string

The identifier for the user who created the resource.

description

string | null

The description to clarify the resource's function within the API. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

link

string | null

The location of the navigable resource within this API, for use by API clients.

lockVersion

integer

The identifier used for optimistic locking. See Concurrency control for details.

private

boolean

Whether the resource is private. API consumers can access private resources only if they identify with an appropriate API key.

resourcePath

string

required

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the resource.

updatedBy

string

The identifier for the user who last modified the resource.

Headers

object

Location

string

Relative URL for created API resource.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/api-definitions/v2/endpoints/apiEndPointId/versions/versionNumber/resources \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Saved API Endpoint Resource data.