Protocol Service

This documentation provides information about the REST API for the Protocol Service.

API Endpoints

getProtocol

• HTTP Method: GET
• Path: /protocols/{protocolId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: ProtocolDTO
  • 400 Bad Request
  • 404 Not Found

updateProtocol

• HTTP Method: PUT
• Path: /protocols/{protocolId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: ProtocolDTO
  • 400 Bad Request
  • 404 Not Found

deleteProtocol

• HTTP Method: DELETE
• Path: /protocols/{protocolId}
• Description: TODO
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

tagProtocol

• HTTP Method: PUT
• Path: /protocols/{protocolId}/tag
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

getFeatureById

• HTTP Method: GET
• Path: /features/{featureId}
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

updateFeature

• HTTP Method: PUT
• Path: /features/{featureId}
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

deleteFeature

• HTTP Method: DELETE
• Path: /features/{featureId}
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

addTagToFeature

• HTTP Method: PUT
• Path: /features/{featureId}/tag
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

getFeatureStat

• HTTP Method: GET
• Path: /features/{featureId}/featurestats/{featureStatId}
• Description:
• Responses:
  • 200 OK
    • Schema: FeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

updateFeatureStat

• HTTP Method: PUT
• Path: /features/{featureId}/featurestats/{featureStatId}
• Description:
• Responses:
  • 200 OK
    • Schema: FeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

deleteFeatureStat

• HTTP Method: DELETE
• Path: /features/{featureId}/featurestats/{featureStatId}
• Description:
• Responses:
  • 204 No Content
  • 400 Bad Request
  • 404 Not Found

updateCalculationInputValue

• HTTP Method: PUT
• Path: /features/{featureId}/calculationinputvalues/{calculationInputValueId}
• Description:
• Responses:
  • 200 OK
    • Schema: CalculationInputValueDTO
  • 400 Bad Request
  • 404 Not Found

deleteCalculationInputValue

• HTTP Method: DELETE
• Path: /features/{featureId}/calculationinputvalues/{calculationInputValueId}
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

getDefaultFeatureStat

• HTTP Method: GET
• Path: /defaultfeaturestats/{defaultFeatureStatId}
• Description:
• Responses:
  • 200 OK
    • Schema: DefaultFeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

updateDefaultFeatureStat

• HTTP Method: PUT
• Path: /defaultfeaturestats/{defaultFeatureStatId}
• Description:
• Responses:
  • 200 OK
    • Schema: DefaultFeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

deleteDefaultFeatureStat

• HTTP Method: DELETE
• Path: /defaultfeaturestats/{defaultFeatureStatId}
• Description:
• Responses:
  • 204 No Content
  • 400 Bad Request
  • 404 Not Found

getProtocols_1

• HTTP Method: GET
• Path: /protocols
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

createProtocol

• HTTP Method: POST
• Path: /protocols
• Description:
• Responses:
  • 200 OK
    • Schema: ProtocolDTO
  • 400 Bad Request
  • 404 Not Found

getFeatures_1

• HTTP Method: GET
• Path: /features
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

createFeature

• HTTP Method: POST
• Path: /features
• Description:
• Responses:
  • 200 OK
    • Schema: FeatureDTO
  • 400 Bad Request
  • 404 Not Found

getFeatureStatByFeatureId

• HTTP Method: GET
• Path: /features/{featureId}/featurestats
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

createFeatureStat

• HTTP Method: POST
• Path: /features/{featureId}/featurestats
• Description:
• Responses:
  • 201 Created
    • Schema: FeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

getCalculationInputValue

• HTTP Method: GET
• Path: /features/{featureId}/calculationinputvalues
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

createCalculationInputValue

• HTTP Method: POST
• Path: /features/{featureId}/calculationinputvalues
• Description:
• Responses:
  • 200 OK
    • Schema: CalculationInputValueDTO
  • 400 Bad Request
  • 404 Not Found

getDefaultFeatureStats

• HTTP Method: GET
• Path: /defaultfeaturestats
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

createDefaultFeatureStat

• HTTP Method: POST
• Path: /defaultfeaturestats
• Description:
• Responses:
  • 201 Created
    • Schema: DefaultFeatureStatDTO
  • 400 Bad Request
  • 404 Not Found

getFeatureStatByProtocolId

• HTTP Method: GET
• Path: /protocols/{protocolId}/featurestats
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

getProtocolFeatures

• HTTP Method: GET
• Path: /protocols/{protocolId}/features
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

getCalculationInputValueByProtocolIds

• HTTP Method: GET
• Path: /protocols/{protocolId}/calculationinputvalues
• Description:
• Responses:
  • 200 OK
  • 400 Bad Request
  • 404 Not Found

Schema Components

CalculationInputValueDTO

• Type: object
• Properties:
  • id (integer, int64):
  • featureId (integer, int64):
  • formulaId (integer, int64):
  • variableName (string):
  • sourceMeasColName (string):
  • sourceFeatureId (integer, int64):
  • inputSource (string):

DRCModelDTO

• Type: object
• Properties:
  • featureId (integer, int64):
  • name (string):
  • description (string):
  • method (string):
  • slope (string):
  • script (string):
  • inputParameters (object):
  • outputParameters (object):

FeatureDTO

• Type: object
• Properties:
  • id (integer, int64):
  • name (string):
  • alias (string):
  • description (string):
  • format (string):
  • type (string):
  • sequence (integer, int32):
  • protocolId (integer, int64):
  • formulaId (integer, int64):
  • civs (array):
  • drcModel (undefined):
  • trigger (string):
  • status (string):
  • deleted (boolean):

ProtocolDTO

• Type: object
• Properties:
  • id (integer, int64):
  • name (string):
  • description (string):
  • lowWelltype (string):
  • highWelltype (string):
  • previousVersion (string):
  • versionNumber (string):
  • features (array):
  • createdOn (string, date-time):
  • createdBy (string):
  • updatedOn (string, date-time):
  • updatedBy (string):

FeatureStatDTO

• Type: object
• Properties:
  • id (integer, int64):
  • featureId (integer, int64):
  • plateStat (boolean):
  • welltypeStat (boolean):
  • name (string):
  • formulaId (integer, int64):

DefaultFeatureStatDTO

• Type: object
• Properties:
  • id (integer, int64):
  • plateStat (boolean):
  • welltypeStat (boolean):
  • name (string):
  • formulaId (integer, int64):