Resource Set
  • 18 Jul 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Resource Set

  • Dark
    Light
  • PDF

Article summary

ResourceSet

/v1/resourceset/{networkid}

List Of Resource Sets

Example for calling:

http://server/v1/resourceset?id=1 - retrieves resource set having id = 1
http://server/v1/resourceset/9 - retrieves resource set assigned to the network having network id = 9
http://server/v1/resourceset?network_id=9 - retrieves resource set assigned to the network having network id = 9
http://server/v1/resourceset?owner=safransa - retrieves resource set owned by safransa
http://server/v1/resourceset - retrieves all resources sets

Allowed Methods:

[GET]
API Controller: resource_set

Description:

Lists all resource set for the supplied network_id or other given request fields.

Request Fields:

NameTypeDescriptionNotes
idintegerId of the resource set[Optional] Returns all available resource sets if missing
network_idintegerId of the network, related to the resource set[Optional] Returns all available resource sets if missing
ownerstringowner of the resource setReturns all available resource sets if missing, also relates to "SafranWebApiOwnerVerificationDuringApiCalls" in "Application Settings"
  1. When "SafranWebApiOwnerVerificationDuringApiCalls" is in use, one of the Ids is mandatory.
  2. When "SafranWebApiOwnerVerificationDuringApiCalls" is in use, and using id - all ids must relate to a resource set with the same owner.
  3. Combining the ID's in one call is not supported.

Response Fields:

NameTypeDescriptionNotes
idintegerUnique resource_set Id
namestringResource set name
ownerstringResource set owner

This is the default topic template. You can write your content here.

Sample JSON Response
[
    {
        "id": 35,
        "name": "#19665 G08 Safran M and M Level 4 - 35",
        "owner": "OVL"
    },
    {
        "id": 9,
        "name": "Tunnel Project History - 9",
        "owner": "OVL"
    },
    {
        "id": 36,
        "name": "Tunnel Project minutes - 36",
        "owner": "OVL"
    },
    {
        "id": 10,
        "name": "Tunnel Start - 10",
        "owner": "OVL"
    }
]


Was this article helpful?