Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.

Anchor
_Toc405205426
_Toc405205426
GET /api/measurementCollectionJob/{ID}

Description :

  • This Uniform Contract operation is used to retrieve the representation of measurementCollectionJob using id.
  • Collection of jobs can be retrieved via GET /api/<RESOURCE> with no {ID}

...

  • GET /api/measurementCollectionJob/1/executionState,scheduleDefinition

Anchor
_Toc405205427
_Toc405205427
GET /api/measurementProductionJob/{ID}

Description :

  • This Uniform Contract operation is used to retrieve the representation of measurementProductionJob using id.
  • Collection of jobs can be retrieved via GET /api/<RESOURCE> with no {ID}

...

  • GET /api/measurementProductionJob/1/executionState,scheduleDefinition

 

Anchor
_Toc405205428
_Toc405205428
GET /api/adhocCollection/{ID}

Description :

  • This Uniform Contract operation is used to retrieve the representation of adhocCollection using id.
  • Collection of jobs can be retrieved via GET /api/<RESOURCE> with no {ID}

...

  • GET /api/measurementCollectionJob/1/granularity,protocolTransferData

 

Anchor
_Toc405205429
_Toc405205429
PUT /api/measurementCollectionJob/{ID}

Description :

  • This Uniform Contract operation is used to modify any specified 'measurementCollectionJob' identified by the id.

...

REQUEST

PUT /api/measurementCollectionJob/collJob001
Accept: application/json
Content-Type: application/json

{
"id": "collJob001",
"creationTime": "11-26-2014 16:00:00 +0530",
"lastModifiedTime": "11-26-2014 16:00:00 +0530",
"adminState": "UNLOCKED",
"jobPriority": "5",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"reportingPeriod": "R_15MN",
"outputFormat": "3GPP",
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

RESPONSE

200
Content-Type: application/json

{
"id": "collJob001",
"creationTime": "11-26-2014 16:00:00 +0530",
"lastModifiedTime": "11-26-2014 16:00:00 +0530",
"adminState": "UNLOCKED",
"jobPriority": "5",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"reportingPeriod": "R_15MN",
"outputFormat": "3GPP",
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

 

Anchor
_Toc405205430
_Toc405205430
PUT /api/measurementProductionJob/{ID}

Description :

  • This Uniform Contract operation is used to modify any specified 'measurementProductionJob' identified by the id.

...

REQUEST

PUT /api/measurementProductionJob/collJob001
Accept: application/json
Content-Type: application/json

{
"id": "prodJob001",
"creationTime": "11-26-2013 16:00:00 +0530",
"lastModifiedTime": "11-26-2013 16:00:00 +0530",
"adminState": "UNLOCKED",
"jobPriority": "5",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

RESPONSE

200
Content-Type: application/json

{
"id": "prodJob001",
"creationTime": "11-26-2013 16:00:00 +0530",
"lastModifiedTime": "11-26-2013 16:00:00 +0530",
"adminState": "UNLOCKED",
"jobPriority": "5",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

 

Anchor
_Toc405205431
_Toc405205431
PUT /api/adhocCollection/{ID}

Description :

  • This Uniform Contract operation is used to modify any specified 'adhocCollection' identified by the id.

...



Example see TMF REST Design Guidelines.

Anchor
_Toc405205432
_Toc405205432
PATCH /api/measurementCollectionJob/{ID}

Description :

  • This Uniform Contract operation is used to partially update the representation of a measurementCollectionJob identified by its id.
  • Resource represents a managed entity.

...

REQUEST

PATCH /api/measurementCollectionJob/collJob001
Accept: application/json
Content-Type: application/json

{
"adminState": "1"
}

RESPONSE

200
Content-Type: application/json

{
"id": "collJob001",
"creationTime": "11-26-2014 16:00:00 +0530",
"lastModifiedTime": "11-26-2014 16:00:00 +0530",
"adminState": "1",
"jobPriority": "5",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"reportingPeriod": "R_15MN",
"outputFormat": "3GPP",
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

 

Anchor
_Toc405205433
_Toc405205433
PATCH /api/measurementProductionJob/{ID}

Description :

  • This Uniform Contract operation is used to partially update the representation of a measurementProductionJob identified by its id.
  • Resource represents a managed entity.

...

REQUEST

PATCH /api/measurementProductionJob/collJob001
Accept: application/json
Content-Type: application/json

{
"jobPriority": "6"
}

RESPONSE

200
Content-Type: application/json

{
"id": "prodJob001",
"creationTime": "11-26-2013 16:00:00 +0530",
"lastModifiedTime": "11-26-2013 16:00:00 +0530",
"adminState": "UNLOCKED",
"jobPriority": "6",
"executionState": "EXECUTING",
"scheduleDefinition": {
"type": "RecurringScheduleDefinition",
"scheduleInfo": {
"scheduleDefinitionStartTime": "11-26-2013 16:00:00 +0530",
"scheduleDefinitionEndTime": "11-26-2014 16:00:00 +0530"
}
},
"consumingApplicationId": "CONSUMER001",
"producingApplicationId": "NE001",
"granularity": "G_15MN",
"monitoredObjectsCriteria": {
"type": "MonitoredClassCriteria",
"monitoredObjectInfo": { "monitoredObjectClass": "SDH-Route" }
},
"protocolTransferData": {
"transportProtocol": "FILE_TRANSFER",
"fileTransferData": {
"fileLocation": "\\pm
pmdata",
"fileFormat": "XML",
"compressionType": "NO_COMPRESSION",
"retentionDuration": {
"units": "MINUTES",
"amount": "180"
},
"packingType": "NO_PACKING"
}
},
"performanceIndicatorGroup": [
{ "name": "TRANSPORT01" },
{ "name": "TRANSPORT02" }
],
"performanceIndicatorSpecification": [
{ "name": "ES" },
{ "name": "SES" },
{ "name": "UAS" },
{ "name": "BBE" },
{ "name": "FEBBE" },
{ "name": "FEES" },
{ "name": "FESES" },
{ "name": "FEUAS" },
{ "name": "UASBID" },
{ "name": "LINK_AVAIL_PCT" }
]
}

 

Anchor
_Toc405205434
_Toc405205434
PATCH /api/adhocCollection/{ID}

Description :

  • This Uniform Contract operation is used to partially update the representation of a adhocCollectionJob identified by its id.
  • Resource represents a managed entity.

...



Anchor
_Ref234978967
_Ref234978967
Anchor
_Toc235288517
_Toc235288517
Anchor
_Toc236554611
_Toc236554611
Anchor
_Toc236554912
_Toc236554912
Anchor
_Toc236555375
_Toc236555375
Anchor
_Toc225613455
_Toc225613455
Anchor
_Toc225603244
_Toc225603244
Anchor
_Ref226733430
_Ref226733430
Anchor
_Ref230885009
_Ref230885009
Anchor
_Ref231980155
_Ref231980155
Anchor
_Ref232940733
_Ref232940733
Anchor
_Ref232940829
_Ref232940829
Example see TMF REST Design Guidelines.

Anchor
_Toc405205435
_Toc405205435
POST /api/measurementCollectionJob

Description :

  • This Uniform Contract operation is used to create the representation of any specified 'measurementCollectionJob'.

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205436
_Toc405205436
POST /api/measurementProductionJob


Description :

  • This Uniform Contract operation is used to create the representation of any specified 'measurementProductionJob'..

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205437
_Toc405205437
POST /api/adhocCollection

Description :

  • This Uniform Contract operation is used to create the representation of any specified 'adhocCollection'.

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205438
_Toc405205438
DELETE /api/measurementCollectionJob/{ID}

This Uniform Contract operation is used to delete a managed entity or a task.
Description :

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205439
_Toc405205439
DELETE /api/measurementProductionJob/{ID}

This Uniform Contract operation is used to delete a managed entity or a task.
Description :

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205440
_Toc405205440
DELETE /api/adhocCollection/{ID}

This Uniform Contract operation is used to delete a managed entity or a task.
Description :

...


Example see TMF REST Design Guidelines.

Anchor
_Toc405205441
_Toc405205441
GET /api/trackingRecord/{ID}

Description :

  • This Uniform Contract operation is used to retrieve the collection of tracking records belonging to a job via the job's id.

...

REQUEST

GET /api/trackingRecord/collJob001
Accept: application/json

RESPONSE

200
Content-Type: application/json

{
"trackingRecord": [
{ "id": "1",
"jobId": "collJob001",
"jobType": "measurementCollectionJob",
"description": "measurementCollectionJob Created successfully",
"time": "11-26-2014 16:00:00 +0530",
"userId": "root",
"systemId": "tmfPm" },
{ "id": "2",
"jobId": "collJob001",
"jobType": "measurementCollectionJob",
"description": "measurementCollectionJob Completed successfully",
"time": "11-26-2014 16:01:00 +0530",
"userId": "root",
"systemId": "tmfPm"
}]
}

 

Anchor
_Toc405205442
_Toc405205442
POST API/getSupportedObjectClassesTask

This Uniform Contract operation retrieves supported object classes.
Description :

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedObjectClassesTask
    Content-type: application/json

    RESPONSE

    201
    Content-Type: application/json

    {
    "supportedObjectClasses": [
    "Blade",
    "VC4",
    "E1-Link"
    ]
    }

     

    Anchor
    _Toc405205443
    _Toc405205443
    POST API/getSupportedObjectsTask

    This Uniform Contract operation list supported objects Instances for the specified Object Class. Object Class specification is optional, & when no Object Class is specified, all Object Instances shall be returned.
    Description :
  • Returns all Object Instances supported by the interface (either all or scoped by the Object Class)

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedObjectsTask
    Content-type: application/json

    {
    "inputClass": "Blade"
    }

    RESPONSE

    201
    Content-Type: application/json

    {
    "supportedObjects": {
    "Object": [
    "/md1/Node1",
    "/md1/Node1/If1"
    ]
    }
    }

     

    Anchor
    _Toc405205444
    _Toc405205444
    POST API/getSupportedIndicatorGroupsTask

    This Uniform Contract operation retrieves supported Indicator Groups. Object Class specification is optional, & when no object Class is specified, all indicator groups shall be returned.
    Description:
  • Returns all indicator groups supported by the interface (either all or scoped by Object Class)

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedIndicatorGroupsTask
    Content-type: application/json

    {
    "inputClass": "Blade"
    }

    RESPONSE

    201
    Content-Type: application/json

    {    "supportedIndicatorGroups": [      "Groups_1",      "Groups_2"    ]}

    Anchor
    _Toc405205445
    _Toc405205445
    POST API/getSupportedIndicatorsTask

    This Uniform Contract operation retrieves supported Indicators. Object Class, Indicator Group specification shall be used to scope the result.
    Description:
  • Returns all indicators supported by the provided Object class and/or Indicator group.
  • If indicator group is provided in input only the indicator instances related to the input object class & specified group shall be returned

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedIndicatorsTask
    Content-type: application/json

    {
    "inputClass": "Blade"
    "inputIndicatorGroup": "Group1"
    }

    RESPONSE

    201
    Content-Type: application/json

    {    "supportedIndicators": [      "SES",      "BBE"    ]}

     

    Anchor
    _Toc405205446
    _Toc405205446
    POST API/getSupportedTransportTask

    This Uniform Contract operation retrieves supported transport supported.
    Description:
  • Returns supported transports

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedTransportTask
    Content-type: application/json

    RESPONSE

    201
    Content-Type: application/json

    {
    "supportedTransport": [
    "SFTP",
    "TFTP"
    ]
    }

     

    Anchor
    _Toc405205447
    _Toc405205447
    POST API/getSupportedFileFormatTask

    This Uniform Contract operation retrieves supported file formats.
    Description:
  • Returns supported file formats

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/getSupportedFileFormatTask
    Content-type: application/json

    RESPONSE

    201
    Content-Type: application/json

    {
    "supportedFileFormat": [
    "3GPP",
    "MTOSI"
    ]
    }

     

    Anchor
    _Toc405205448
    _Toc405205448
    POST API/getCommonIndicatorGroupsGranularitiesTask

    This Uniform Contract operation retrieves the list of granularities which are common to a set of indicator groups.
    Description:
  • Returns common granularities for a set of indicator groups

...

REQUEST

POST API/ getCommonIndicatorGroupsGranularitiesTask
Content-type: application/json
{
"inputIndicatorGroups": ["Grp_1", "Grp_2"]
}

RESPONSE

201
Content-Type: application/json

{
"commonGranularities": [
"G_15MN",
"G_30MN"
]
}

 

Anchor
_Toc405205449
_Toc405205449
POST API/getCommonIndicatorsGranularitiesTask

This Uniform Contract operation retrieves the list of granularities which are common to a set of indicators.
Description:

...

  • 200 OK – requst was successfull
  • 404 Not Found.

    REQUEST

    POST API/ getCommonIndicatorGroupsGranularitiesTask
    Content-type: application/json
    {
    "inputIndicators": ["SES", "BBE"]
    }

    RESPONSE

    201
    Content-Type: application/json
    {
    "commonGranularities ": [
    "G_15MN",
    "G_30MN"
    ]
    }

     

    Anchor
    _Toc405205450
    _Toc405205450
    POST API/listAvailableFilesTask

    This Uniform Contract operation list available files for a given job & time scope.
    Description :
  • Returns all files generated by the server and available for download

...