Product

GET/api/app/product/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

creationTimestring (date-time)

creatorIdnullable string (uuid)

namenullable string

descriptionnullable string

pricingnullable array of Snam.Platform.Products.Dtos.PricingDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/product/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2024-11-27T19:48:09.538Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "pricing": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "internalName": "text",
      "type": 1,
      "usageType": 1,
      "isUsageBased": false,
      "usageCalculationMethod": 1,
      "model": 1,
      "billingCycle": 1,
      "items": [
        {
          "amount": 0,
          "fromQuantity": 0,
          "toQuantity": 0
        }
      ]
    }
  ]
}

PUT/api/app/product/{id}

Path parameters

id*string (uuid)

Body

application/jsontext/jsonapplication/*+json

namenullable string

descriptionnullable string

pricingnullable array of Snam.Platform.Products.Dtos.PricingDto (object)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/product/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}

DELETE/api/app/product/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/product/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}

GET/api/app/product

Query parameters

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of Snam.Platform.Products.Dtos.ProductDto (object)

totalCountinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/product', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2024-11-27T19:48:09.538Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "pricing": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "internalName": "text",
          "type": 1,
          "usageType": 1,
          "isUsageBased": false,
          "usageCalculationMethod": 1,
          "model": 1,
          "billingCycle": 1,
          "items": [
            {
              "amount": 0,
              "fromQuantity": 0,
              "toQuantity": 0
            }
          ]
        }
      ]
    }
  ]
}

POST/api/app/product

Body

application/jsontext/jsonapplication/*+json

namenullable string

descriptionnullable string

pricingnullable array of Snam.Platform.Products.Dtos.PricingDto (object)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/product', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}