Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Operation

Information of the operation

GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/segment


Request


PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortstringfalserequest parameteridProperty of the entity to sort by.
sortModestringfalserequest parameterascMode of sorting.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/segment


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId of the Segment
codestringtrueCode of the Segment
namestringtrueName of the Segment
propertyIdintfalseId of the property (Only for multiproperty request)

Example response

{
  "count": 10,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 2,
      "code": "CS1",
      "name": "ChainSegment 1"
    },
    {
      "id": 8,
      "code": "CS2",
      "name": "ChainSegment 2"
    },
    {
      "id": 14,
      "code": "CS3",
      "name": "ChainSegment 3"
    },
    {
      "id": 20,
      "code": "CS4",
      "name": "ChainSegment 4"
    },
    {
      "id": 26,
      "code": "CS5",
      "name": "ChainSegment 5"
    },
    {
      "id": 32,
      "code": "CS6",
      "name": "ChainSegment 6"
    },
    {
      "id": 38,
      "code": "CS7",
      "name": "ChainSegment 7"
    },
    {
      "id": 44,
      "code": "CS8",
      "name": "ChainSegment 8"
    },
    {
      "id": 50,
      "code": "CS9",
      "name": "ChainSegment 9"
    },
    {
      "id": 56,
      "code": "CS10",
      "name": "ChainSegment 10"
    }
  ]
}
  • No labels