support-scheduler API documentation version 1.1.x

http://localhost:48085/api

Welcome

Welcome to the Scheduler Microservice API Documentation.

Interval Resource (by name)

Example - http://localhost:48085/api/v1/info/midnight (where midnight is the name of an Interval)

get

get

Return Interval matching given name (interval names should be unique). May be null if no interval matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

Return Interval matching given name (interval names should be unique). May be null if no interval matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

interval matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"meta data around anything that needs to be scheduled (frequency with optional start and end times).","title":"interval","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"start":{"type":"integer","required":false,"title":"start"},"end":{"type":"integer","required":false,"title":"end"},"frequency":{"type":"integer","required":false,"title":"frequency"}}}

Example:

{"created":0,"modified":0,"origin":0,"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","name":"midnight","start":"20180101T000000","end":null,"frequency":"P1D","cron":null,"runOnce":false}

HTTP status code 404

if no interval is found for the identifier provided.

HTTP status code 500

for unknown or unanticipated issues

Ping Resource

Example - http://localhost:48081/api/v1/ping

get

get

ping

IntervalAction Resource (by id)

Example - http://localhost:48081/api/v1/intervalaction/00d14a4c-cb4c-4750-a24b-f0f89d27fc82

delete get

delete

Remove the IntervalAction designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided id. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

get

Fetch a specific IntervalAction by database generated id. May return null if no interval action with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided id.

Remove the IntervalAction designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided id. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no IntervalAction is found with the provided id

HTTP status code 409

if an attempt to delete a interval action still being referenced by device reports

HTTP status code 503

for unknown or unanticipated issues

Fetch a specific IntervalAction by database generated id. May return null if no interval action with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided id.

URI Parameters

  • id: (string)

HTTP status code 200

interval action matching on the id

Body

Type: application/json

Schema:

intervalaction

Example:

{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1471895607378,"modified":1471895971882,"origin":1471806386919,"name":"scrub pushed records","addressable":{"name":"scrub pushed records"},"parameters":null,"interval":"daily","service":"edgex-support-scheduler"}

HTTP status code 404

if no IntervalAction is found with the provided id

HTTP status code 500

for unknown or unanticipated issues

IntervalAction Resource (by name)

Example - http://localhost:48081/api/v1/intervalaction/name/scrub pushed records (where 'scrub pushed records' is a interval action name)

delete get

delete

Remove the IntervalAction designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

get

Return IntervalActions matching given name (interval names should be unique). May be null if no interval events matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name.

Remove the IntervalAction designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no IntervalAction is found with the provided name

HTTP status code 409

if an attempt to delete a interval action still being referenced by device reports

HTTP status code 500

for unknown or unanticipated issues

Return IntervalActions matching given name (interval names should be unique). May be null if no interval events matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

interval action matching on name

Body

Type: application/json

Schema:

intervalaction

Example:

{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1471895607378,"modified":1471895971882,"origin":1471806386919,"name":"scrub pushed records","addressable":{"name":"scrub pushed records"},"parameters":null,"interval":"daily","service":"edgex-support-scheduler"}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no IntervalAction is found with the provided name

HTTP status code 500

for unknown or unanticipated issues

IntervalAction Resource (by target name)

Example - http://localhost:48081/api/v1/intervalaction/target/core-data (returns all intervalaction(s) associated with the target core-data)

delete get

delete

Remove the IntervalAction(s) designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

get

Return IntervalActions matching given name (interval names should be unique). May be null if no interval events matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name.

Remove the IntervalAction(s) designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name. DataValidationException (HTTP 409) if an attempt to delete a interval action still being referenced by device reports.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no IntervalAction is found with the provided name

HTTP status code 409

if an attempt to delete a interval action still being referenced by device reports

HTTP status code 500

for unknown or unanticipated issues

Return IntervalActions matching given name (interval names should be unique). May be null if no interval events matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no IntervalAction is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

interval action matching on name

Body

Type: application/json

Schema:

intervalaction

Example:

{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1471895607378,"modified":1471895971882,"origin":1471806386919,"name":"scrub pushed records","addressable":{"name":"scrub pushed records"},"parameters":null,"interval":"daily","service":"edgex-support-scheduler"}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no IntervalAction is found with the provided name

HTTP status code 500

for unknown or unanticipated issues

IntervalAction Resource

Example - http://localhost:48081/api/v1/intervalaction

post put get

post

Add a new IntervalAction - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if the action's associated interval is not found (referenced by name). DataValidationException (HTTP 409) if the interval was not provided.

put

Update the IntervalAction identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. DataValidationException (HTTP 409) if an attempt to change the name is made when the interval action is still being referenced by device reports. NotFoundException (HTTP 404) if no interval is found for the identifier provided.

get

Return all interval events sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new IntervalAction - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if the action's associated interval is not found (referenced by name). DataValidationException (HTTP 409) if the interval was not provided.

Body

Type: application/json

Schema:

intervalaction

Example:

{"origin":1471806386919,"name":"scrub pushed records","addressable":{"name":"scrub pushed records"},"parameters":null,"interval":"daily","service":"edgex-support-scheduler"}

HTTP status code 200

database generated identifier for the new interval

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if the action's associated interval is not found (referenced by name)

HTTP status code 409

if the interval was not provided or if the name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues or if interval action name is a duplicate

Interval Resource

Example - http://localhost:48081/api/v1/interval/00d14a4c-cb4c-4750-a24b-f0f89d27fc82

delete get

delete

Remove the Interval designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided id.

get

Fetch a specific Interval by database generated id. May return null if no interval with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided id.

Remove the Interval designated by database generated id. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided id.

URI Parameters

  • id: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 404

if no interval is found for the identifier provided.

HTTP status code 503

for unknown or unanticipated issues

Fetch a specific Interval by database generated id. May return null if no interval with the id is found. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided id.

URI Parameters

  • id: (string)

HTTP status code 200

interval matching on the id

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"meta data around anything that needs to be scheduled (frequency with optional start and end times).","title":"interval","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"start":{"type":"integer","required":false,"title":"start"},"end":{"type":"integer","required":false,"title":"end"},"frequency":{"type":"integer","required":false,"title":"frequency"}}}

Example:

{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1471891942854,"modified":1471893402687,"origin":1471806386919,"name":"hourly","start":1503360000,"end":1503390000,"frequency":60000,"cron":null,"runOnce":"false"}

HTTP status code 404

if no interval is found for the identifier provided.

HTTP status code 500

for unknown or unanticipated issues

Interval Resource (by name)

Example - http://localhost:48081/api/v1/interval/name/hourly (where hourly is the name of a interval)

delete get

delete

Remove the Interval designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

get

Return Interval matching given name (interval names should be unique). May be null if no interval matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

Remove the Interval designated by name. Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

boolean indicating success of the remove operation

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no interval is found for the name provided.

HTTP status code 500

for unknown or unanticipated issues

Return Interval matching given name (interval names should be unique). May be null if no interval matches on the name provided. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. NotFoundException (HTTP 404) if no Interval is found with the provided name.

URI Parameters

  • name: (string)

HTTP status code 200

interval matching on name

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"meta data around anything that needs to be scheduled (frequency with optional start and end times).","title":"interval","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"start":{"type":"integer","required":false,"title":"start"},"end":{"type":"integer","required":false,"title":"end"},"frequency":{"type":"integer","required":false,"title":"frequency"}}}

Example:

{"id":"00d14a4c-cb4c-4750-a24b-f0f89d27fc82","created":1471891942854,"modified":1471893402687,"origin":1471806386919,"name":"hourly","start":1503360000,"end":1503390000,"frequency":60000,"cron":null,"runOnce":"false"}

HTTP status code 400

for malformed or unparsable requests

HTTP status code 404

if no interval is found for the identifier provided.

HTTP status code 500

for unknown or unanticipated issues

Interval Resource

Example - http://localhost:48081/api/v1/interval

post put get

post

Add a new Interval - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. DataValidationException (HTTP 409) if the cron expression string is not properly formatted.

put

Update an Interval identified by the id or name in the object provided. Id is used first, name is used second for identification purposes. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. DataValidationException (HTTP // 409) if any the time or frequency strings are not properly formatted. NotFoundException (HTTP 404) if no interval is found for the id.

get

Return all intervals sorted by id. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. Returns LimitExceededException (HTTP 413) if the number returned exceeds the max limit.

Add a new Interval - name must be unique. Returns Internal Service Error (HTTP 500) for unknown or unanticipated issues. DataValidationException (HTTP 409) if the cron expression string is not properly formatted.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"meta data around anything that needs to be scheduled (frequency with optional start and end times).","title":"interval","properties":{"id":{"type":"string","required":false,"title":"id"},"created":{"type":"integer","required":false,"title":"created"},"modified":{"type":"integer","required":false,"title":"modified"},"origin":{"type":"integer","required":false,"title":"origin"},"name":{"type":"string","required":false,"title":"name"},"start":{"type":"integer","required":false,"title":"start"},"end":{"type":"integer","required":false,"title":"end"},"frequency":{"type":"integer","required":false,"title":"frequency"}}}

Example:

{"origin":1471806386919,"name":"hourly","start":"20160101T000000","end":"","frequency":"PT1H"} or {"origin":1471806386919,"name":"at midnight","start":"20160101T000000","frequency":"PT1D"} or {"origin":1471806386919,"name":"daily noon","start":"20160101T120000","frequency":"PT1D"}

HTTP status code 200

database generated identifier for the new interval

HTTP status code 400

for malformed or unparsable requests

HTTP status code 409

if the start, end, or frequency strings are not properly formatted or if the name is determined to not be unique with regard to others

HTTP status code 500

for unknown or unanticipated issues

Edgex API Version

Example - http://localhost:48081/api/version

get

get

Get the API version