DwhManagement

Schema

The considered APS type (download) looks as follows:

{
  "name": "DwhManagement",
  "id": "http://www.odin.com/dwh/management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/abstract/types/unlimited-resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "getDashboard": {
      "path": "getDashboard",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "updateKpiMetrics": {
      "path": "updateKPI/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateCustomerTrend": {
      "path": "updateCustomerTrend/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateSubscriptionTrend": {
      "path": "updateSubscriptionTrend/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateRevenuePerPlan": {
      "path": "updatePlanRevenue/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updatePSA": {
      "path": "updatePsaData/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "fillPSAAPSResource": {
      "path": "fillPSAAPSResource/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateRevenueTrendMonth": {
      "path": "updateRevenueTrendMonth/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateRevenueTotal": {
      "path": "updateRevenueTotal/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateRevenueVendor": {
      "path": "updateRevenueVendor/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "updateVendor": {
      "path": "updateVendor/{requestId}",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        },
        "requestId": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
getDashboard	GET	/getDashboard
updateKpiMetrics	POST	/updateKPI/{requestId}
updateCustomerTrend	POST	/updateCustomerTrend/{requestId}
updateSubscriptionTrend	POST	/updateSubscriptionTrend/{requestId}
updateRevenuePerPlan	POST	/updatePlanRevenue/{requestId}
updatePSA	POST	/updatePsaData/{requestId}
fillPSAAPSResource	POST	/fillPSAAPSResource/{requestId}
updateRevenueTrendMonth	POST	/updateRevenueTrendMonth/{requestId}
updateRevenueTotal	POST	/updateRevenueTotal/{requestId}
updateRevenueVendor	POST	/updateRevenueVendor/{requestId}
updateVendor	POST	/updateVendor/{requestId}

getDashboard

HTTP Request

GET /aps/2/resources/{aps-id}/getDashboard

Description

Returns

updateKpiMetrics

HTTP Request

POST /aps/2/resources/{aps-id}/updateKPI/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateCustomerTrend

HTTP Request

POST /aps/2/resources/{aps-id}/updateCustomerTrend/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateSubscriptionTrend

HTTP Request

POST /aps/2/resources/{aps-id}/updateSubscriptionTrend/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateRevenuePerPlan

HTTP Request

POST /aps/2/resources/{aps-id}/updatePlanRevenue/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updatePSA

HTTP Request

POST /aps/2/resources/{aps-id}/updatePsaData/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

fillPSAAPSResource

HTTP Request

POST /aps/2/resources/{aps-id}/fillPSAAPSResource/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateRevenueTrendMonth

HTTP Request

POST /aps/2/resources/{aps-id}/updateRevenueTrendMonth/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateRevenueTotal

HTTP Request

POST /aps/2/resources/{aps-id}/updateRevenueTotal/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateRevenueVendor

HTTP Request

POST /aps/2/resources/{aps-id}/updateRevenueVendor/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

updateVendor

HTTP Request

POST /aps/2/resources/{aps-id}/updateVendor/{requestId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String
requestId	String

Returns

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Reporting and Data Export

RDEBaseReportCustomization →