ProjectScopeConfiguration

Updated on 12 Nov 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

ProjectScopeConfiguration

/v1/projectscopeconfiguration/{id}

Retrieves one or more projects scope configuration details.

Regarding relation of network_id and project_id see project_previews for more details.

Example for calling:

http://server/v1/projectscopeconfiguration?id=1 - Retrieves details for project having project_id = 1

http://server/v1/projectscopeconfiguration?network_id=2 - Retrieves details for project having net_id = 2

http://server/v1/projectscopeconfiguration?item_guid=87de7975-097a-45b9-aaf8-51793e74cbdf - Retrieves details for network having guid = 87de7975-097a-45b9-aaf8-51793e74cbdf

http://server/v1/projectscopeconfiguration?owner=SAFRAN - Retrieves details for project owned by user SAFRAN

http://server/v1/projectscopeconfiguration?network_id=2&owner=SAFRAN - Retrieves details for project having net_id = 2 and owned by user SAFRAN

http://server/v1/projectscopeconfiguration - Is not permitted.

Allowed Methods:

[GET]

API Controller: project

Description:

Retrieves the project scope configuration details of a project for specified id, or all user owned projects when owner is specified.

API Methods Scope Config

Request Fields:

Name	Type	Description	Notes
id	integer	Id of the project	Optional Returns details for provided project id
network_id	integer	id of the related network	Optional Returns details for provided network id
owner	string	Owner of the project	Relates to "SafranWebApiOwnerVerificationDuringApiCalls" in Application Settings
item_guid	guid	guid of the network	Optional Returns details for provided guid

When "SafranWebAPIOwnerVerificationDuringApiCalls" is in use the network_id is mandatory.
If ID, network_id and/or guid is passed to the API, all given values will be used.

Response Fields:

Name	Type	Description	Notes
project_id	integer	Unique ID of the project
scope_type	string	"csh" or "rsh" or "tsh"	csh - Baseline scope rsh - Current scope tsh - Total scope
qty_type	string	"planned" or "contract"
variation_order	boolean
variation_order_request	boolean
internal_change	boolean
sub_contracted	boolean

Show Response Sample

json result

[
  {
    "project_id": 1,
    "scope_type": "csh",
    "qty_type": "planned",
    "variation_order": true,
    "variation_order_request": false,
    "internal_change": false,
    "sub_contracted": false
    
    },
  {
    "project_id": 1,
    "scope_type": "rsh",
    "qty_type": "planned",
    "variation_order": true,
    "variation_order_request": false,
    "internal_change": false,
    "sub_contracted": false
    
    },
  {
    "project_id": 1,
    "scope_type": "tsh",
    "qty_type": "planned",
    "variation_order": true,
    "variation_order_request": true,
    "internal_change": false,
    "sub_contracted": false
    
    }
]

Was this article helpful?

What's Next

Cutoff

Table of contents