Organization Management API
{ urn:com.soa.rest.services.orgmgmt } OrgMgmtREST
This API is used to manage PM organizations.
POST/organizationsAdd a new organization
Add a new Organization under a given parent. For brevity, the following request creates an organization with minimal parameters. It is possible to add organization contact, corresponding email, phone and address and also any Operational/QoS/Compliance policies using this request.
Request:
POST /rest/organizations HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey":"uddi:soa.com:registryorganization",
"Name":"New Organization ",
"Description":"This is a new org ",
"Url":"http://local:80",
"OrganizationType":"Application",
"OrganizationContact":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name":"New Org Adding Contact",
"Description":"",
"UseType":"Official",
"OrganizationContactEmail":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Email":"x@y.com",
"UseType":"Personal"
}
],
"OrganizationContactPhone":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Phone":"9999999999",
"UseType":"Personal"
}
],
"OrganizationContactAddress":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
]
}
]
}
Response:
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey":"uddi:soa.com:registryorganization",
"Name":"New Organization",
"Description":"This is a new org",
"OrganizationType":"Application",
"OperationalPolicyAttachment":[
],
"QoSPolicyAttachment":[
],
"CompliancePolicyAttachment":[
]
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
Organization
Organization {
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
OperationalPolicyAttachment( Collection of PolicyAttachmentType )
QoSPolicyAttachment( Collection of PolicyAttachmentType )
Description( string )
OrganizationContact( Collection of OrganizationContact, required )
CompliancePolicyAttachment( Collection of PolicyAttachmentType )
Links( Collection of atomLink )
OrganizationType( string )
ParentKey( string )
Url( anyURI )
OrganizationKey( string )
Name( string )
}
PolicyAttachmentType {
Categories( Collection of Category, required )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string, required )
TModelKey( string, required )
KeyValue( string, required )
}
OrganizationContact {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress, required )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail, required )
OrganizationContactPhone( Collection of OrganizationContactPhone, required )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
Reponse
Status Code
Reason
Model
200
Success
any
PUT/organizations/{orgKey}Modify organization with given key
Modify Organization with given key. For brevity, Org Contact, Policies etc are not included.
Request:
PUT /rest/organizations/{orgKey} HTTP/1.1
{
"OrganizationKey": "uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ParentKey": "uddi:soa.com:registryorganization",
"Name": "New Organization Modified",
"Description": "This is a new org Modified",
"Url": "http://local:80",
"OrganizationType": "Application"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
Organization
Organization {
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
OperationalPolicyAttachment( Collection of PolicyAttachmentType )
QoSPolicyAttachment( Collection of PolicyAttachmentType )
Description( string )
OrganizationContact( Collection of OrganizationContact, required )
CompliancePolicyAttachment( Collection of PolicyAttachmentType )
Links( Collection of atomLink )
OrganizationType( string )
ParentKey( string )
Url( anyURI )
OrganizationKey( string )
Name( string )
}
PolicyAttachmentType {
Categories( Collection of Category, required )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string, required )
TModelKey( string, required )
KeyValue( string, required )
}
OrganizationContact {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress, required )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail, required )
OrganizationContactPhone( Collection of OrganizationContactPhone, required )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
DELETE/organizations/{orgKey}Delete organization
Delete Organization for a given key.
Request:
DELETE /rest/organizations/{orgKey} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
GET/organizations/{orgKey}Get organization
Get details of organization based on given organization key
Request:
GET /rest/organizations/{orgKey}
Response:
{
"OrganizationKey":"uddi:5b7972c3-3bc5-11e5-82f4-850713ba2d72",
"ParentKey":"uddi:soa.com:registryorganization",
"Name":"My Org",
"Description":"",
"OrganizationType":"Application",
"OperationalPolicyAttachment":[
],
"QoSPolicyAttachment":[
],
"CompliancePolicyAttachment":[
]
}
Parameters
Name
Type
Description
Model
orgKey
path
Organization Key
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
Organization
Organization {
PolicyAttachmentType {
Category {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
atomLink {
OperationalPolicyAttachment( Collection of PolicyAttachmentType )
QoSPolicyAttachment( Collection of PolicyAttachmentType )
Description( string )
OrganizationContact( Collection of OrganizationContact )
CompliancePolicyAttachment( Collection of PolicyAttachmentType )
Links( Collection of atomLink )
OrganizationType( string )
ParentKey( string )
Url( anyURI )
OrganizationKey( string )
Name( string )
}
PolicyAttachmentType {
Categories( Collection of Category )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string )
TModelKey( string )
KeyValue( string )
}
OrganizationContact {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail )
OrganizationContactPhone( Collection of OrganizationContactPhone )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
GET/organizations/{orgKey}/childrenGet organization children
Get child organizations of an organization.
Parameters
Name
Type
Description
Model
orgKey
path
Organization Key
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
organizations
organizations {
Organizations {}
atomLink {
Organizations( Collection of Organizations )
Links( Collection of atomLink )
}
Organizations {}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
POST/organizations/{orgKey}/contactsAdd a new organization contact
Add a new organizational contact along with given details like phone, email and address etc.
Request:
POST /rest/organizations/{orgKey}/contacts/ HTTP/1.1
{
"OrganizationKey":"uddi :e99c14e8-37b0-11e5-a5e2-eef5b5b2411e ",
"Name":"New Org Adding Contact",
"Description":"",
"UseType":"Official",
"OrganizationContactEmail ":[
{
"OrganizationKey":"uddi :e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Email":"x@y.com",
"UseType":"Personal"
}
],
"OrganizationContactPhone":[
{
"OrganizationKey":"uddi :e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Phone":"9999999999",
"UseType":"Personal"
}
],
"OrganizationContactAddress":[
{
"OrganizationKey":"uddi :e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
]
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
OrganizationContact
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress, required )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail, required )
OrganizationContactPhone( Collection of OrganizationContactPhone, required )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
GET/organizations/{orgKey}/contactsGet organizational contacts
Get all organizational contacts for a given organization based on org key
Request:
GET /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
{
"OrganizationContact":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name":"New Org Adding Contact",
"Description":"",
"UseType":"Official",
"OrganizationContactEmail":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Email":"x@y.com",
"UseType":"Personal"
}
],
"OrganizationContactPhone":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Phone":"9999999999",
"UseType":"Personal"
}
],
"OrganizationContactAddress":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
]
}
]
}
Parameters
Name
Type
Description
Model
orgKey
path
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
OrganizationContacts
OrganizationContacts {
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
OrganizationContact( Collection of OrganizationContact )
}
OrganizationContact {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail )
OrganizationContactPhone( Collection of OrganizationContactPhone )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
POST/organizations/{orgKey}/identitiesAssign Identity to a given organization
Assign Identity to a given organization
Request:
POST /rest/organizations/{orgKey}/identities HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
OrganizationIdentity
OrganizationIdentity {
QualifiedUserName( string, required )
OrganizationKey( string, required )
}
PUT/organizations/{orgKey}/contacts/{useType}Modify organizational contact
Modify organizational contact based on given key and use type.
Request:
PUT /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name":"New Org Modifying Contact",
"Description":"Modified Description",
"UseType":"Official"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
useType
path
string
body
entity
OrganizationContact
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress, required )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail, required )
OrganizationContactPhone( Collection of OrganizationContactPhone, required )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
DELETE/organizations/{orgKey}/contacts/{useType}Delete organizational contact
Delete a given organizational contact based on given org key and contact use type
Request:
DELETE /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
useType
path
string
GET/organizations/{orgKey}/contacts/{useType}Get organizational contact
Get organizational contact information based on given org key and use type
Request:
GET /rest/organizations/{orgKey}/contacts/{useType} HTTP/1.1
Response:
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"Name":"New Org Adding Contact",
"Description":"",
"UseType":"Official",
"OrganizationContactEmail":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Email":"x@y.com",
"UseType":"Personal"
}
],
"OrganizationContactPhone":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Phone":"9999999999",
"UseType":"Personal"
}
],
"OrganizationContactAddress":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
]
}
Parameters
Name
Type
Description
Model
orgKey
path
string
useType
path
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
OrganizationContact
OrganizationContact {
OrganizationContactAddress {
OrganizationContactEmail {
OrganizationContactPhone {
Description( string )
OrganizationContactAddress( Collection of OrganizationContactAddress )
UseType( string )
OrganizationContactEmail( Collection of OrganizationContactEmail )
OrganizationContactPhone( Collection of OrganizationContactPhone )
OrganizationKey( string )
Name( string )
}
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
POST/organizations/{orgKey}/policies/operationalAttach operational policy to given org
Attach operational policy to a given organization using given policy info
Request:
POST /rest/ organizations/{orgKey}/policies/operational HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"DetailedAuditing"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
PolicyAttachmentType
PolicyAttachmentType {
Category {
Categories( Collection of Category, required )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string, required )
TModelKey( string, required )
KeyValue( string, required )
}
GET/organizations/{orgKey}/policies/operationalGet operational policy information
Get operational policy info based on given org key
Request:
GET /rest/organizations/{orgKey}/policies/operational HTTP/1.1
Response:
{
"PolicyAttachment":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"DetailedAuditing"
}
]
}
Parameters
Name
Type
Description
Model
orgKey
path
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
PolicyAttachments
PolicyAttachments {
PolicyAttachmentType {
Category {
PolicyAttachment( Collection of PolicyAttachmentType )
}
PolicyAttachmentType {
Categories( Collection of Category )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string )
TModelKey( string )
KeyValue( string )
}
POST/organizations/{orgKey}/policies/qosAttach QoS policy to given org
Attach QoS policy to a given organization using given policy info
Request:
POST /rest/ organizations/{orgKey}/policies/qos HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
PolicyAttachmentType
PolicyAttachmentType {
Category {
Categories( Collection of Category, required )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string, required )
TModelKey( string, required )
KeyValue( string, required )
}
GET/organizations/{orgKey}/policies/qosGet QoS policy information
Get QoS policy info based on given org key
Request:
GET /rest/organizations/{orgKey}/policies/qos HTTP/1.1
Response:
{
"PolicyAttachment":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
]
}
Parameters
Name
Type
Description
Model
orgKey
path
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
PolicyAttachments
PolicyAttachments {
PolicyAttachmentType {
Category {
PolicyAttachment( Collection of PolicyAttachmentType )
}
PolicyAttachmentType {
Categories( Collection of Category )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string )
TModelKey( string )
KeyValue( string )
}
POST/organizations/{orgKey}/policies/complianceAttach Compliance policy to given org
Attach Compliance policy to a given organization using given policy info
Request:
POST /rest/ organizations/{orgKey}/policies/compliance HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
body
entity
PolicyAttachmentType
PolicyAttachmentType {
Category {
Categories( Collection of Category, required )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string, required )
TModelKey( string, required )
KeyValue( string, required )
}
GET/organizations/{orgKey}/policies/complianceGet Compliance policy information
Get Compliance policy info based on given org key
Request:
GET /rest/organizations/{orgKey}/policies/compliance HTTP/1.1
Response:
{
"PolicyAttachment":[
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"PolicyName":"urn:uuid:20bb5fdd-3f12-11e5-ae8d-df99efc65381"
}
]
}
Parameters
Name
Type
Description
Model
orgKey
path
string
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
PolicyAttachments
PolicyAttachments {
PolicyAttachmentType {
Category {
PolicyAttachment( Collection of PolicyAttachmentType )
}
PolicyAttachmentType {
Categories( Collection of Category )
PolicyName( string )
OrganizationKey( string )
}
Category {
KeyName( string )
TModelKey( string )
KeyValue( string )
}
DELETE/organizations/{orgKey}/identities/{qualifiedUserName}Un-Assign Identity to a given organization
Un-Assign Identity to a given organization
Request:
DELETE /rest/organizations/{orgKey}/identities/{qualifiedUserName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
qualifiedUserName
path
string
POST/organizations/{orgKey}/contacts/{useType}/emailAdd email address to a given organizational contact
Add email addresses for a given organizational contact based on org key and use type.
Request:
POST /rest/organizations/{orgKey}/contacts/{useType}/email HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"Email":"a@b.com",
"UseType":"Personal"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
useType
path
string
body
entity
OrganizationContactEmail
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
POST/organizations/{orgKey}/contacts/{contactUseType}/phonesAdd a phone number for a given org contact
Add phone information for a given org contact based on org key and contact use type
Request:
POST /rest/organizations/{orgKey}/contacts/{useType}/phones HTTP/1.1
{
"Phone":"9999999999",
"UseType":"Personal"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
body
entity
OrganizationContactPhone
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
POST/organizations/{orgKey}/contacts/{contactUseType}/addressesAdd an address for a given org contact
Add address information for a given org contact based on org key and contact use type
Request:
POST /rest/organizations/{orgKey}/contacts/{useType}/addresses HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
body
entity
OrganizationContactAddress
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
DELETE/organizations/{orgKey}/policies/operational/{policyName}Detach operational policy to given org
Detach operational policy to a given organization using given policy info
Request:
DELETE /rest/organizations/{orgKey}/policies/operational/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
policyName
path
string
DELETE/organizations/{orgKey}/policies/qos/{policyName}Detach QoS policy to given org
Detach QoS policy to a given organization using given policy info
Request:
DELETE /rest/organizations/{orgKey}/policies/qos/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
policyName
path
string
DELETE/organizations/{orgKey}/policies/compliance/{policyName}Detach Compliance policy to given org
Detach Compliance policy to a given organization using given policy info
Request:
DELETE /rest/organizations/{orgKey}/policies/compliance/{policyName} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
policyName
path
string
PUT/organizations/{orgKey}/identities/{qualifiedUserName}/keystoreLoad Identity using PKI Data
Load Identity using PKI Data
Request:
PUT /rest/organizations/{orgKey}/identities/{qualifiedUserName}/keystore HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"QualifiedUserName":"a",
"KeyStoreInfo":{
"Location":"",
"Store":"",
"Type":"",
"Password":"",
"Alias":"",
"AliasPassword":""
}
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
qualifiedUserName
path
string
body
entity
OrganizationIdentityKeyStoreInfo
OrganizationIdentityKeyStoreInfo {
KeyStoreInfo {
KeyStoreInfo( KeyStoreInfo, required )
QualifiedUserName( string, required )
OrganizationKey( string, required )
}
KeyStoreInfo {
Type( string )
AliasPassword( string )
Alias( string )
Store( base64Binary )
Location( anyURI )
Password( string )
}
PUT/organizations/{orgKey}/contacts/{contactUseType}/email/{useType}Modify email address of a given contact
Modify email address of a given contact based on org key, contact use type and email use type
Request:
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/email/{useType} HTTP/1.1
{
"Email":"mmm@nnn.com"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string
body
entity
OrganizationContactEmail
OrganizationContactEmail {
Email( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
DELETE/organizations/{orgKey}/contacts/{contactUseType}/email/{useType}Delete email address of a given organization contact
Delete email address of a given org contact based on org key, contact use type and use type.
Request:
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/email/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string
PUT/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType}Modify a phone number for a given org contact
Modify phone information for a given org contact based on org key and contact use type and phone use type
Request:
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType} HTTP/1.1
{
"Phone":"2222222222"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string
body
entity
OrganizationContactPhone
OrganizationContactPhone {
Phone( string )
UseType( string )
ContactUseType( string )
OrganizationKey( string )
}
DELETE/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType}Delete a phone number for a given org contact
Delete phone information for a given org contact based on org key and contact use type and phone use type
Request:
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/phones/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string
PUT/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType}Modify a address info for a given org contact
Modify address information for a given org contact based on org key, contact use type, and phone use type
Request:
PUT /rest/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType} HTTP/1.1
{
"OrganizationKey":"uddi:e99c14e8-37b0-11e5-a5e2-eef5b5b2411e",
"ContactUseType":"Official",
"UseType":"Personal",
"Address1":"Address Line 1",
"Address2":"Address Line 2",
"Address3":"Address Line 3",
"Address4":"Address Line 4",
"Address5":"Address Line 5"
}
Response:
HTTP/1.1 204 No Content
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string
body
entity
OrganizationContactAddress
OrganizationContactAddress {
Address4( string )
UseType( string )
Address5( string )
Address2( string )
Address3( string )
ContactUseType( string )
Address1( string )
OrganizationKey( string )
}
DELETE/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType}Delete an address info for a given org contact
Delete address information for a given org contact based on org key, contact use type, and phone use type
Request:
DELETE /rest/organizations/{orgKey}/contacts/{contactUseType}/addresses/{useType} HTTP/1.1
Response:
HTTP/1.1 204 No Content
Parameters
Name
Type
Description
Model
orgKey
path
string
contactUseType
path
string
useType
path
string