Prev | Next |
Retrieving Resources and Resource Features
Enterprise Architect supports retrieving these Resources and Resource Features via the HTTP GET Verb:
- Resources
- Model Roots
- Packages
- Elements
- Diagrams - Resource Features
- Package and Element Connectors, Discussions, Discussion Replies, Requirements, Constraints,
Scenarios, Files, Linked Documents, Resource Allocations, Tests, Tagged Values, Maintenance
Items and Project Management Items
- Element Run States, Attributes, Attribute Tagged Values, Operations, Operation Tagged Values
and Operation Parameters
- Diagram Image
Each of these Resource and Resource Feature types is identified by a prefix on the GUID; see the Guid Prefix Tables Help topic.
When retrieving Resources and Resource Features, you must provide the User Authentication Token via the query string parameter 'useridentifier'; see the User Credentials for accessing OSLC RESTful API Help topic.
Model Root, Package, Element, Diagram
Type |
URL |
---|---|
Object |
<protocol>://<server>/<model_name>/oslc/am/resource/<Resource GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/resource/ |
Package/Element Link (Connector)
Type |
URL |
---|---|
Link |
<protocol>://<server>/<model_name>/oslc/am/linkedresources/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/linktype/ |
Element Run State
Type |
URL |
---|---|
All RunStates on an Element |
<protocol>://<server>/<model_name>/oslc/am/runstates/<Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific RunState |
<protocol>://<server>/<model_name>/oslc/am/runstate/<RunState GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/runstate/ |
Element Attribute
Type |
URL |
---|---|
All Attributes on an Element |
<protocol>://<server>/<model_name>/oslc/am/attributes/<Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Attribute |
<protocol>://<server>/<model_name>/oslc/am/attribute/<Attribute GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/attribute/ |
Attribute Tagged Value
Type |
URL |
---|---|
All Tagged Values on an Attribute |
<protocol>://<server>/<model_name>/oslc/am/taggedvalues/<Attribute GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Tagged Value on an Attribute |
<protocol>://<server>/<model_name>/oslc/am/taggedvalue/<Attribute Tagged Value GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/taggedvalue/ |
Element Operation
Type |
URL |
---|---|
All Operations on an Element |
<protocol>://<server>/<model_name>/oslc/am/operations/<Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Operation |
<protocol>://<server>/<model_name>/oslc/am/operation/<Operation GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/operation/ |
Operation Tagged Value
Type |
URL |
---|---|
All Tagged Values on an Operation |
<protocol>://<server>/<model_name>/oslc/am/taggedvalues/<Operation GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Tagged Value on an Operation |
<protocol>://<server>/<model_name>/oslc/am/taggedvalue/<Operation Tagged Value GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/taggedvalue/ |
Operation Parameter
Type |
URL |
---|---|
All Parameters on an Operation |
<protocol>://<server>/<model_name>/oslc/am/parameters/<Operation GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Operation Parameter |
<protocol>://<server>/<model_name>/oslc/am/parameter/<Parameter GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/operationparameter/ |
Package/Element Tagged Value
Type |
URL |
---|---|
All Tagged Values on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/taggedvalues/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Tagged Value |
<protocol>://<server>/<model_name>/oslc/am/taggedvalue/<Tagged Value GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/taggedvalue/ |
Package/Element/Diagram Discussion
Type |
URL |
---|---|
All Discussions on a Package/Element/Diagram |
<protocol>://<server>/<model_name>/oslc/am/discussions/<Package/Element/Diagram GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Discussion |
<protocol>://<server>/<model_name>/oslc/am/discussion/<Discussion GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/discussion/ |
Package/Element/Diagram Discussion Reply
Type |
URL |
---|---|
All Replies on a Discussion |
<protocol>://<server>/<model_name>/oslc/am/replies/<Discussion GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Discussion Reply |
<protocol>://<server>/<model_name>/oslc/am/reply/<Reply GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/discussion/ |
Package/Element Requirement
Type |
URL |
---|---|
All Requirements on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/requirements/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Requirement |
<protocol>://<server>/<model_name>/oslc/am/requirement/<Requirement GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/requirement/ |
Package/Element Constraint
Type |
URL |
---|---|
All Constraints on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/constraints/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Constraint |
<protocol>://<server>/<model_name>/oslc/am/constraint/<Constraint GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
protocol>://<server>/<model_name>/oslc/am/rs/constraint/ |
Package/Element Scenario
Type |
URL |
---|---|
All Scenarios on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/scenarios/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Scenario |
<protocol>://<server>/<model_name>/oslc/am/scenario/<Scenario GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/scenario/ |
Package/Element File
Type |
URL |
---|---|
All Files on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/files/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific File |
<protocol>://<server>/<model_name>/oslc/am/file/<File GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/file/ |
Package/Element Linked Document
Type |
URL |
---|---|
Document |
<protocol>://<server>/<model_name>/oslc/am/linkeddocument/<Linked Document GUID With Prefix>/?useridentifier=<User Authentication Token> |
Package/Element Resource Allocation
Type |
URL |
---|---|
All Resource Allocations on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/resourceallocations/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Resource Allocation |
<protocol>://<server>/<model_name>/oslc/am/resourceallocation/<Resource Allocation GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/resourceallocation/ |
Package/Element Test
Type |
URL |
---|---|
All Tests on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/tests/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Test |
<protocol>://<server>/<model_name>/oslc/am/test/<Test GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/test/ |
Package/Element Change
Type |
URL |
---|---|
All Changes on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/changes/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Change |
<protocol>://<server>/<model_name>/oslc/am/change/<Change GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/change/ |
Package/Element Defect
Type |
URL |
---|---|
All Defects on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/defects/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Defect |
<protocol>://<server>/<model_name>/oslc/am/defect/<Defect GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/defect/ |
Package/Element Issue
Type |
URL |
---|---|
URL - All Issues on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/issues/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
URL - Specific Issue |
<protocol>://<server>/<model_name>/oslc/am/issue/<Issue GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/issue/ |
Package/Element Task
Type |
URL |
---|---|
All Tasks on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/tasks/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Task |
<protocol>://<server>/<model_name>/oslc/am/task/<Task GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/task/ |
Package/Element Event
Type |
URL |
---|---|
All Events on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/events/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Event |
<protocol>://<server>/<model_name>/oslc/am/event/<Event GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/event/ |
Package/Element Decision
Type |
URL |
---|---|
All Decisions on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/decisions/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Decision |
<protocol>://<server>/<model_name>/oslc/am/decision/<Decision GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/decision/ |
Package/Element Document
Type |
URL |
---|---|
All Documents on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/documents/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Document |
<protocol>://<server>/<model_name>/oslc/am/document/<Document GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/document/ |
Package/Element Feature
Type |
URL |
---|---|
All Features on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/mfeatures/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Feature |
<protocol>://<server>/<model_name>/oslc/am/mfeature/<Document GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/mfeature/ |
Package/Element Effort
Type |
URL |
---|---|
All Efforts on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/efforts/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Effort |
<protocol>://<server>/<model_name>/oslc/am/effort/<Effort GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/effort/ |
Package/Element Risk
Type |
URL |
---|---|
All Risks on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/risks/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Risk |
<protocol>://<server>/<model_name>/oslc/am/risk/<Risk GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/risk/ |
Package/Element Metric
Type |
URL |
---|---|
All Metrics on a Package/Element |
<protocol>://<server>/<model_name>/oslc/am/metrics/<Package/Element GUID With Prefix>/?useridentifier=<User Authentication Token> |
Specific Metric |
<protocol>://<server>/<model_name>/oslc/am/metric/<Metric GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/metric/ |
Diagram Image
Type |
URL |
---|---|
Diagram Image |
<protocol>://<server>/<model_name>/oslc/am/diagramimage/<Diagram Image GUID With Prefix>/?useridentifier=<User Authentication Token> |
Resource Shape |
<protocol>://<server>/<model_name>/oslc/am/rs/diagramimage/ |
Examples of Resource/Resource Feature Retrieval
Item |
Example |
---|---|
1 |
Retrieve a Package:
http://localhost:480/firebird_model/oslc/am/resource/pk_{5147E138-1F14-4738-B721-5FCC0F8821A8}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} |
2 |
Retrieve an element:
http://localhost:480/firebird_model/oslc/am/resource/el_{24B2D93C-03F1-4761-9BB8-3B837B44E985}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} |
3 |
Retrieve all Operations on an element:
http://localhost:480/firebird_model/oslc/am/operations/el_{24B2D93C-03F1-4761-9BB8-3B837B44E985}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} |
4 |
Retrieve an Operation:
http://localhost:480/firebird_model/oslc/am/operation/op_{E356ECA8-8C23-4c16-B94B-154A5A9B2B42}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} |
5 |
Retrieve all Tests on an element:
http://localhost:480/firebird_model/oslc/am/tests/el_{24B2D93C-03F1-4761-9BB8-3B837B44E985}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} |
Notes
- This facility is available through the Pro Cloud Server, with a valid license
- GET request to retrieve the Resource/Resource Feature will not be processed by the Pro Cloud Server unless the User Authentication Token is passed in with the request (via the 'useridentifier' query string in the URL)
Learn more
- GUID Prefix Tables
- User Credentials for accessing OSLC RESTful API
- Model Packages
- UML Elements
- Requirements
- Constraints
- Scenarios
- Associated Files
- Run-time State
- Attributes
- Attribute Tagged Values
- Operations
- Define Parameters
- Operation Tagged Values
- UML Connectors
- Model Discussions
- Linked Documents
- Resource Allocation
- Create Test Records
- Tagged Values
- Create Maintenance Items
- Effort Management
- Risk Management
- Metrics