Script Management API
{ urn:com.soa.rest.services.script } ScriptAdmin
The API used to manage PM scripts.
GET/pmscriptsReturns a list of scripts.
Returns all scripts within a given organization, without any script content.
Parameters
Name
Type
Description
Model
org
query
The organization key.
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}
POST/pmscriptsCreates a script
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
The script spec
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}
DELETE/pmscripts/{key}Deletes a script
Parameters
Name
Type
Description
Model
key
path
The script key
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
any
PUT/pmscripts/{key}Updates a script
Parameters
Accepts application/xml text/xml application/json
Name
Type
Description
Model
key
path
The script key.
string
body
entity
The changed script
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}
GET/pmscripts/typesReturns a list of script types
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
ScriptEngineType
ScriptEngineType {
DisplayName( string )
Id( string )
Name( string )
}
GET/pmscripts/{key}Gets a list of script types
Parameters
Name
Type
Description
Model
key
path
The script key
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
ScriptSpec
ScriptSpec {
ScriptType( string )
Description( string )
Id( string )
Key( string )
Name( string )
OrganizationKey( string )
}