Creating Resources

TIBCO Scribe® API resources support POST requests only where applicable. POST operations that create a resource require a model for the resource being created. The TIBCO Scribe® API endpoint documentation identifies any required model property values. Only property values that are required or that are being updated must be included in the model.

  • If you include an ID value in the model, an error occurs.
  • If you include a value for any property that the POST method generates, the value you specify is ignored.

When a successful POST operation returns, it returns both the HTTP Response code of 201, Created, and the complete model of the resource that was created. The model contains any properties that were set, defaulted, or generated, including the resource ID. For example, the following adds the Solution to an Organization and returns a fully populated model for the Solution that was just created:

POST https://api.scribesoft.com/v1/orgs/12345678/solutions

{

"Name": "Test Solution 1",

"AgentId": "ec312f57-c4ab-46fb-b109-4c0020b68c0d",

"Description": "This is a test Solution"

}

See

API Basics