Back to top

Batches

Batches Management

Retrieve all batches by project
GET
/projects/{id}/batches

Returns all batches for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"batches": [
    		{
    			"id": "string",
    			"state": "string",
    			"error_messages": [
    				"string"
    			],
    			"quantity": "integer",
    			"created_at": "string",
    			"href": "string",
    			"project": {
    				"href": "string"
    			},
    			"instances": {
    				"href": "string"
    			}
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve a Batch
GET
/batches/{id}

Returns a Batch

  • Parameters
  • id
    string  (required) in path

    Batch UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"state": "string",
    	"error_messages": [
    		"string"
    	],
    	"quantity": "integer",
    	"created_at": "string",
    	"href": "string",
    	"project": {
    		"href": "string"
    	},
    	"instances": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  404   not found