MEC010-2_AppLcm.json 112 KB
Newer Older
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    },
    "/app_instances/{appInstanceId}/instantiate": {
      "post": {
        "tags": [
          "app-lcm"
        "summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
        "description": "task of instantiating an application instance.",
        "operationId": "appLcmInstanciatePOST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
          "description": "",
          "content": {
            "application/json": {
Elian Kraja's avatar
Elian Kraja committed
              "schema": {
                "$ref": "#/components/schemas/InstantiateAppRequest"
              }
            }
          },
          "required": true
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    },
    "/app_instances/{appInstanceId}/terminate": {
      "post": {
        "tags": [
          "app-lcm"
        ],
        "summary": "terminate an application instance.",
        "description": "terminate an application instance.",
        "operationId": "appLcmTerminatePOST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
          "description": "",
          "content": {
            "application/json": {
Elian Kraja's avatar
Elian Kraja committed
              "schema": {
                "$ref": "#/components/schemas/TerminateAppRequest"
              }
          },
          "required": true
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    },
    "/app_instances/{appInstanceId}/operate": {
      "post": {
        "tags": [
          "app-lcm"
        ],
        "summary": "change the operational state, i.e. start or stop, of the application instance",
        "description": "change the operational state, i.e. start or stop, of the application instance",
        "operationId": "appLcmOperatePOST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Identifier of an individual application instance",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OperateAppRequest"
          },
          "required": true
            "description": "accepted for processing, but the processing has not yet been completed.",
            "headers": {},
            "content": {}
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    },
    "/app_lcm_op_occs": {
      "get": {
        "tags": [
          "app-lcm"
        ],
        "summary": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences",
        "description": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences",
        "operationId": "appLcmOpOccsGET",
Elian Kraja's avatar
Elian Kraja committed
        "parameters": [
            "in": "query",
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
            "in": "query",
            "description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
            "style": "form",
            "explode": true,
            "in": "query",
            "description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
            "style": "form",
            "explode": true,
            "in": "query",
            "description": "Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.",
            "style": "form",
            "explode": true,
        "responses": {
          "200": {
            "description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AppLcmOpOcc"
                  },
                  "description": "",
                  "contentMediaType": "application/json"
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    "/app_lcm_op_occs/{appLcmOpOccId}": {
      "get": {
        "tags": [
          "app-lcm"
        ],
        "summary": "reads the status information of an individual application LCM operation occurrence",
        "description": "reads the status information of an individual application LCM operation occurrence",
        "operationId": "appLcmOpOccsbyIdGET",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Information about an application LCM operation occurrence was read successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppLcmOpOcc"
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        },
        "deprecated": false
      },
    },
    "/app_lcm_op_occs/{appLcmOpOccId}/cancel": {
      "post": {
        "tags": [
          "app-lcm"
        "summary": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
        "description": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
        "operationId": "appLcmCancelPOST",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelMode"
              }
            }
          "required": true
        },
        "responses": {
          "202": {
            "description": "The request was accepted for processing, but it is possible that the processing is not yet completed.",
            "headers": {},
            "content": {}
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          "409": {
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
        "deprecated": false
    },
    "/app_lcm_op_occs/{appLcmOpOccId}/fail": {
      "post": {
        "tags": [
          "app-lcm"
        "summary": "marks an application lifecycle management operation occurrence as \"finally failed\"",
        "description": "marks an application lifecycle management operation occurrence as \"finally failed\"",
        "operationId": "appLcmFailPOST",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
        "responses": {
          "202": {
            "description": "Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppLcmOpOcc"
                }
              }
            }
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
    },
    "/app_lcm_op_occs/{appLcmOpOccId}/retry": {
      "post": {
        "tags": [
          "app-lcm"
        ],
        "summary": "initiate retrying an application lifecycle operation that has experience a temporary failure",
        "description": "initiate retrying an application lifecycle operation that has experience a temporary failure",
        "operationId": "appLcmRetryPOST",
        "parameters": [
          {
            "name": "appLcmOpOccId",
            "in": "path",
            "description": "Identifies an individual application LCM operation occurrence",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request was accepted for processing, but it is possible that the processing is not yet completed",
            "headers": {},
            "content": {}
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
    },
    "/app_instances/{appInstanceId}/configure_platform_for_app": {