Skip to main content
Version: Early Access

rest-1.v1/New

This topic explains how to use Agility to create new endpoints.

Overview​

This endpoint provides a template for creating new assets. A new asset template contains suggested attribute values for a new asset. These values can be changed and new attributes added. Then the whole template can be posted to rest-1.v1/Data to create a new asset. Often a new asset should be created in the "context" of another asset. For example, if you ask for a new Story asset in the context of an Request asset, the new Story asset will carry over some attributes from the Request. A few of these attributes are the Name, Description, Scope, and a relationship back to the originating Request.

This endpoint does not attempt to pre-populate required attributes. Therefore, required attributes must be added to the template before posting back to rest-1.v1/Data.

URL Form<Server Base URI>/rest-1.v1/New/<asset type>?ctx=<OID Token>
AuthenticationApplication
HTTP Request VerbHTTP GET
Response Content Typetext/xml

API

Request Parameters​

Examples​

The following requests the basic Story template. Since no context was provided, no attributes can be pre-populated.

                <Server Base URI>/rest-1.v1/New/Story

The following requests a Story template with a Scope as context.

                <Server Base URI>/rest-1.v1/New/Story?ctx=Scope:0

The following requests a Story template with a Request as context.

                <Server Base URI>/rest-1.v1/New/Story?ctx=Request:1684