Prev Next

Deleting Resources and Resource Features

Enterprise Architect supports a Resource and Resource Feature deletion service, through which Clients can use HTTP DELETE to delete existing Resources and Resource Features of these types:

  • Resources
         -  Model Roots
         -  Packages
         -  Elements
         -  Diagrams
         -  Connectors
  • Resource Features
         -  Package/Element/Diagram Discussions, Discussion Replies, Requirements, Constraints,
            Resource Allocations, Tests, Scenarios, Files, Linked Documents,
            Tagged Values, Maintenance Items and Project Management Items
         -  Element Run States, Attributes, Attribute Tagged Values, Operations,
            Operation Tagged Values and Operation Parameters

To delete an existing Resource/Resource Feature, the Client performs an HTTP DELETE on the Resource/Resource Feature URL. If successful, a '200 OK' response will be generated. If unsuccessful an error response will be generated.

When deleting Resource/Resource Feature, you must provide the User Authentication Token via the query string parameter 'useridentifier'; see the User Credentials for accessing OSLC RESTful API Help topic.

Refer to the tables in this topic for the information used to delete each Resource and Feature. Also see the GUID Prefix Tables topic.

Model Root, Package, Element, Diagram

Type

URL

Object

<protocol>://<server>/<model_name>/oslc/am/resource/<Resource GUID With Prefix>/?useridentifier=<User Authentication Token>

Package/Element Link (Connector)

Type

URL

Link

<protocol>://<server>/<model_name>/oslc/am/linktyperesource/<Connector GUID With Prefix>/?useridentifier=<User Authentication Token>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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/<Feature GUID With Prefix>/?useridentifier=<User Authentication Token>

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>

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>

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>

Examples of Resource/Resource Feature Deletion

Item

Example

1

Delete a Package:

  • whose Enterprise Architect GUID is {5147E138-1F14-4738-B721-5FCC0F8821A8}
  • where User Authentication Token is {72825AF9-E116-48f1-9DF8-77815E66B1A7}

http://localhost:480/firebird_model/oslc/am/resource/pk_{5147E138-1F14-4738-B721-5FCC0F8821A8}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7}

2

Delete an element:

  • whose Enterprise Architect GUID is {24B2D93C-03F1-4761-9BB8-3B837B44E985}
  • where User Authentication Token is {72825AF9-E116-48f1-9DF8-77815E66B1A7}

http://localhost:480/firebird_model/oslc/am/resource/el_{24B2D93C-03F1-4761-9BB8-3B837B44E985}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7}

3

Delete all Operations on an element:

  • whose Enterprise Architect GUID is {24B2D93C-03F1-4761-9BB8-3B837B44E985}
  • where User Authentication Token is {72825AF9-E116-48f1-9DF8-77815E66B1A7}

http://localhost:480/firebird_model/oslc/am/operations/el_{24B2D93C-03F1-4761-9BB8-3B837B44E985}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7}

4

Delete an Operation:

  • whose Enterprise Architect GUID is {E356ECA8-8C23-4c16-B94B-154A5A9B2B42}
  • where User Authentication Token is {72825AF9-E116-48f1-9DF8-77815E66B1A7}

http://localhost:480/firebird_model/oslc/am/operation/op_{E356ECA8-8C23-4c16-B94B-154A5A9B2B42}/?useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7}

5

Delete all Tests on an element:

  • whose Enterprise Architect GUID is {24B2D93C-03F1-4761-9BB8-3B837B44E985}
  • where User Authentication Token is {72825AF9-E116-48f1-9DF8-77815E66B1A7}

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
  • This facility will not be available when the Pro Cloud Server connection to the Enterprise Architect model is configured as a read-only connection
  • OSLC request to delete 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)
  • When a Resource/Resource Feature is deleted via OSLC in a model that has Auditing enabled, the changes made to the model will not be logged
  • Deleting a Package will delete all its child Packages, elements and features; depending on the size of the Package this can prove to be a resource intensive task, so when the request for deleting a Package is accepted a '202 Accepted' message will be generated
    This means that the process of deleting a Package has not been completed; if a subsequent GET request on the Package returns a '404 Not Found' message, it means that the Package has been completely deleted, else, if the Package XML is returned, it means that the Package deletion is not yet complete

Learn more