dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts@v1.0.2/common/echo_api_constants.go (about)

     1  //
     2  // Copyright (C) 2023 IOTech Ltd
     3  //
     4  // SPDX-License-Identifier: Apache-2.0
     5  
     6  package common
     7  
     8  // Constants related to defined routes with path params in the v3 service APIs for Echo
     9  // TODO: Remove in EdgeX 4.0 and will use the original API constant names defined in constants.go
    10  const (
    11  	ApiEventServiceNameProfileNameDeviceNameSourceNameEchoRoute = ApiEventRoute + "/:" + ServiceName + "/:" + ProfileName + "/:" + DeviceName + "/:" + SourceName
    12  	ApiEventIdEchoRoute                                         = ApiEventRoute + "/" + Id + "/:" + Id
    13  	ApiEventCountByDeviceNameEchoRoute                          = ApiEventCountRoute + "/" + Device + "/" + Name + "/:" + Name
    14  	ApiEventByDeviceNameEchoRoute                               = ApiEventRoute + "/" + Device + "/" + Name + "/:" + Name
    15  	ApiEventByTimeRangeEchoRoute                                = ApiEventRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    16  	ApiEventByAgeEchoRoute                                      = ApiEventRoute + "/" + Age + "/:" + Age
    17  
    18  	ApiReadingCountByDeviceNameEchoRoute                       = ApiReadingCountRoute + "/" + Device + "/" + Name + "/:" + Name
    19  	ApiReadingByDeviceNameEchoRoute                            = ApiReadingRoute + "/" + Device + "/" + Name + "/:" + Name
    20  	ApiReadingByResourceNameEchoRoute                          = ApiReadingRoute + "/" + ResourceName + "/:" + ResourceName
    21  	ApiReadingByTimeRangeEchoRoute                             = ApiReadingRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    22  	ApiReadingByResourceNameAndTimeRangeEchoRoute              = ApiReadingByResourceNameEchoRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    23  	ApiReadingByDeviceNameAndResourceNameEchoRoute             = ApiReadingRoute + "/" + Device + "/" + Name + "/:" + Name + "/" + ResourceName + "/:" + ResourceName
    24  	ApiReadingByDeviceNameAndResourceNameAndTimeRangeEchoRoute = ApiReadingByDeviceNameAndResourceNameEchoRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    25  	ApiReadingByDeviceNameAndTimeRangeEchoRoute                = ApiReadingByDeviceNameEchoRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    26  
    27  	ApiDeviceProfileByNameEchoRoute                 = ApiDeviceProfileRoute + "/" + Name + "/:" + Name
    28  	ApiDeviceProfileDeviceCommandByNameEchoRoute    = ApiDeviceProfileByNameEchoRoute + "/" + DeviceCommand + "/:" + CommandName
    29  	ApiDeviceProfileResourceByNameEchoRoute         = ApiDeviceProfileByNameEchoRoute + "/" + Resource + "/:" + ResourceName
    30  	ApiDeviceProfileByIdEchoRoute                   = ApiDeviceProfileRoute + "/" + Id + "/:" + Id
    31  	ApiDeviceProfileByManufacturerEchoRoute         = ApiDeviceProfileRoute + "/" + Manufacturer + "/:" + Manufacturer
    32  	ApiDeviceProfileByModelEchoRoute                = ApiDeviceProfileRoute + "/" + Model + "/:" + Model
    33  	ApiDeviceProfileByManufacturerAndModelEchoRoute = ApiDeviceProfileRoute + "/" + Manufacturer + "/:" + Manufacturer + "/" + Model + "/:" + Model
    34  
    35  	ApiDeviceResourceByProfileAndResourceEchoRoute = ApiDeviceResourceRoute + "/" + Profile + "/:" + ProfileName + "/" + Resource + "/:" + ResourceName
    36  
    37  	ApiDeviceServiceByNameEchoRoute = ApiDeviceServiceRoute + "/" + Name + "/:" + Name
    38  	ApiDeviceServiceByIdEchoRoute   = ApiDeviceServiceRoute + "/" + Id + "/:" + Id
    39  
    40  	ApiDeviceIdExistsEchoRoute        = ApiDeviceRoute + "/" + Check + "/" + Id + "/:" + Id
    41  	ApiDeviceNameExistsEchoRoute      = ApiDeviceRoute + "/" + Check + "/" + Name + "/:" + Name
    42  	ApiDeviceByIdEchoRoute            = ApiDeviceRoute + "/" + Id + "/:" + Id
    43  	ApiDeviceByNameEchoRoute          = ApiDeviceRoute + "/" + Name + "/:" + Name
    44  	ApiDeviceByProfileIdEchoRoute     = ApiDeviceRoute + "/" + Profile + "/" + Id + "/:" + Id
    45  	ApiDeviceByProfileNameEchoRoute   = ApiDeviceRoute + "/" + Profile + "/" + Name + "/:" + Name
    46  	ApiDeviceByServiceIdEchoRoute     = ApiDeviceRoute + "/" + Service + "/" + Id + "/:" + Id
    47  	ApiDeviceByServiceNameEchoRoute   = ApiDeviceRoute + "/" + Service + "/" + Name + "/:" + Name
    48  	ApiDeviceNameCommandNameEchoRoute = ApiDeviceByNameEchoRoute + "/:" + Command
    49  
    50  	ApiProvisionWatcherByIdEchoRoute          = ApiProvisionWatcherRoute + "/" + Id + "/:" + Id
    51  	ApiProvisionWatcherByNameEchoRoute        = ApiProvisionWatcherRoute + "/" + Name + "/:" + Name
    52  	ApiProvisionWatcherByProfileNameEchoRoute = ApiProvisionWatcherRoute + "/" + Profile + "/" + Name + "/:" + Name
    53  	ApiProvisionWatcherByServiceNameEchoRoute = ApiProvisionWatcherRoute + "/" + Service + "/" + Name + "/:" + Name
    54  
    55  	ApiSubscriptionByNameEchoRoute     = ApiSubscriptionRoute + "/" + Name + "/:" + Name
    56  	ApiSubscriptionByCategoryEchoRoute = ApiSubscriptionRoute + "/" + Category + "/:" + Category
    57  	ApiSubscriptionByLabelEchoRoute    = ApiSubscriptionRoute + "/" + Label + "/:" + Label
    58  	ApiSubscriptionByReceiverEchoRoute = ApiSubscriptionRoute + "/" + Receiver + "/:" + Receiver
    59  
    60  	ApiNotificationCleanupByAgeEchoRoute       = ApiBase + "/" + Cleanup + "/" + Age + "/:" + Age
    61  	ApiNotificationByTimeRangeEchoRoute        = ApiNotificationRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    62  	ApiNotificationByAgeEchoRoute              = ApiNotificationRoute + "/" + Age + "/:" + Age
    63  	ApiNotificationByCategoryEchoRoute         = ApiNotificationRoute + "/" + Category + "/:" + Category
    64  	ApiNotificationByLabelEchoRoute            = ApiNotificationRoute + "/" + Label + "/:" + Label
    65  	ApiNotificationByIdEchoRoute               = ApiNotificationRoute + "/" + Id + "/:" + Id
    66  	ApiNotificationByStatusEchoRoute           = ApiNotificationRoute + "/" + Status + "/:" + Status
    67  	ApiNotificationBySubscriptionNameEchoRoute = ApiNotificationRoute + "/" + Subscription + "/" + Name + "/:" + Name
    68  
    69  	ApiTransmissionByIdEchoRoute               = ApiTransmissionRoute + "/" + Id + "/:" + Id
    70  	ApiTransmissionByAgeEchoRoute              = ApiTransmissionRoute + "/" + Age + "/:" + Age
    71  	ApiTransmissionBySubscriptionNameEchoRoute = ApiTransmissionRoute + "/" + Subscription + "/" + Name + "/:" + Name
    72  	ApiTransmissionByTimeRangeEchoRoute        = ApiTransmissionRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
    73  	ApiTransmissionByStatusEchoRoute           = ApiTransmissionRoute + "/" + Status + "/:" + Status
    74  	ApiTransmissionByNotificationIdEchoRoute   = ApiTransmissionRoute + "/" + Notification + "/" + Id + "/:" + Id
    75  
    76  	ApiDeviceCallbackNameEchoRoute  = ApiBase + "/callback/device/name/:name"
    77  	ApiProfileCallbackNameEchoRoute = ApiBase + "/callback/profile/name/:name"
    78  	ApiWatcherCallbackNameEchoRoute = ApiBase + "/callback/watcher/name/:name"
    79  
    80  	ApiIntervalByNameEchoRoute         = ApiIntervalRoute + "/" + Name + "/:" + Name
    81  	ApiIntervalActionByNameEchoRoute   = ApiIntervalActionRoute + "/" + Name + "/:" + Name
    82  	ApiIntervalActionByTargetEchoRoute = ApiIntervalActionRoute + "/" + Target + "/:" + Target
    83  )