| Anchor | ||||
|---|---|---|---|---|
|
For every single resource managed by the API provide a JSON based representation of the managed entities and tasks.
| Anchor | ||||
|---|---|---|---|---|
|
An Individual represents a physical person.
JSON representation of an Individual
...
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
UML Model:
| Anchor | ||||
|---|---|---|---|---|
|
JSON representation of an Organization
...
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
name | Name of the related party |
validFor | The period for which the related party is valid |
UML Model:
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
An ExportJob resource represents a TASK used to export resources to a File
The ExportJob resource supports the following properties:
Attribute name | Description |
query | Used to scope the exported data (identical to GET filter construct using target ID as base) |
path | URL of the root resource acting as the source for streaming content to the file specified by the ExportJob |
content-type | The format of the exported data .By default "application/json" |
status | notstarted, running, succeeded, failed |
url | URL of the File containing the data to be exported
|
completionDate | Date at which the Job was completed. |
creationDate | Date at which the Job was created. |
errorLog | Reason for Failure |
...
{ "id": "54", "href": "http:/api/catalogManagement/exportJob/54", "status": "running", "path": "partyManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.myParty.com/party/54" } |
UML Model:
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
An ImportJob resource represent a TASK used to import resources from a File
The ImportJob resource supports the following properties:
Attribute name | Description |
content-type | The format of the imported data. By default "application/json" |
path | URL of the root resource where the content of the file specified by the ImportJob must be applied |
status | notstarted, running, succeeded, failed |
url | URL of the File containing the data to be imported
|
completionDate | Date at which the Job was completed. |
creationDate | Date at which the Job was created. |
errorLog | Reason for Failure if status is failed |
...
{ "id": "54", "href": "http:/api/ partyManagement/importJob/54", "status": "completed", "path": "partyManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.myParty.com/party/54" } |
UML Model:
| Anchor | ||||
|---|---|---|---|---|
|
8 notification event types are defined :
...
UML Model:
Event: ExportJobCompletionNotification
{ "eventType": "ExportJobCompletionNotification", "eventTime": "2014-09-27T05:46:25.0Z", "eventId": "1154278", "event": {"exportJob": { "id": "54", "href": "http:/api/partyManagement/exportJob/54", "status": "succeeded", "path": "partyManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.myParty.com/partyManagement/54.json" }} } |
Event: ImportJobCompletionNotification
{ "eventType": "ImportJobCompletionNotification", "eventTime": "2014-09-27T05:46:25.0Z", "eventId": "1154278", "event": {"importJob": { "id": "54", "href": "http:/api/partyManagement/importJob/54", "status": "succeeded", "path": "partyManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.myParty.com/partyManagement/54.json" }} } |
© TM Forum 2015. All Rights Reserved