Find flavors by filtering criteria.

GET 
/v1/projects/:projectId/flavors

Return flavors that match all filtering criteria. Filtering criteria are flavor name. A request without filtering criteria returns all flavors contained in the catalog.

Request

Path Parameters

projectId stringrequired

Project Identifier

Query Parameters

name string

Name of the resource.

offset int32
Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.
Default value: 0
limit int32
Possible values: >= 1
Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).
Default value: 100
sort string

Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

X-API-KEY string

Your SIU token if you use this API through Orange Developer.

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

Response Headers

X-Total-Count

Returns Pagination of response. The total number of items in the collection, after application of filters if any.

X-Result-Count

The actual number of items contained in the response body. Note that it can be less than the requested "limit".

application/json

Schema

Schema

Array [
namestringrequired
Unique resource name.
descriptionstring
Resource description.
]

Example (auto)

[
  {
    "name": "string",
    "description": "string"
  }
]

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/flavors' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

name — query

offset — query

limit — query

sort — query

X-API-KEY — header

Authorization — header

X-Requester-Id — header