Updating Resources

Many TIBCO Scribe® API resources support PUT methods. You must supply a model for the resource that you are updating:

  • If you specify an ID value, it must match the ID value in the path or an error occurs.
  • If you submit a value for a property that the PUT method generates, the value you specify is ignored.
  • Any other values submitted by the PUT method update the corresponding property values in the model.

If you do not want to update a property, do one of the following:

  • Do not provide the property in the model
  • Set the model property value to null

If you want to clear a property, provide the default, non-null value for that property in the model, as follows:

String = “”

Numeric = 0

Bool = false

DateTime = DateMin

ID = “” OR "00000000-0000-0000-0000-000000000000"

When a PUT operation is successful, it returns both the HTTP Response code of 200, OK, and the complete, updated model of the resource. For example, the following updates the command model to change the Solution description and returns the updated, fully populated model for the Solution ID ec312f57-c4ab-46fb-b109-2c0022b01c0d:

PUT https://api.scribesoft.com/v1/orgs/12345678/solutions/ec312f57-c4ab-46fb-b109-2c0022b01c0d

{

"Description": "This is an updated test Solution"

}

See

API Basics