Jsflagr.ConstraintApi

February 12, 2019 ยท View on GitHub

All URIs are relative to http://localhost/api/v1

MethodHTTP requestDescription
createConstraintPOST /flags/{flagID}/segments/{segmentID}/constraints
deleteConstraintDELETE /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}
findConstraintsGET /flags/{flagID}/segments/{segmentID}/constraints
putConstraintPUT /flags/{flagID}/segments/{segmentID}/constraints/{constraintID}

createConstraint

Constraint createConstraint(flagID, segmentID, body)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.ConstraintApi();

var flagID = 789; // Number | numeric ID of the flag

var segmentID = 789; // Number | numeric ID of the segment

var body = new Jsflagr.CreateConstraintRequest(); // CreateConstraintRequest | create a constraint


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createConstraint(flagID, segmentID, body, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
segmentIDNumbernumeric ID of the segment
bodyCreateConstraintRequestcreate a constraint

Return type

Constraint

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteConstraint

deleteConstraint(flagID, segmentID, constraintID)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.ConstraintApi();

var flagID = 789; // Number | numeric ID of the flag

var segmentID = 789; // Number | numeric ID of the segment

var constraintID = 789; // Number | numeric ID of the constraint


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteConstraint(flagID, segmentID, constraintID, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
segmentIDNumbernumeric ID of the segment
constraintIDNumbernumeric ID of the constraint

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

findConstraints

[Constraint] findConstraints(flagID, segmentID)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.ConstraintApi();

var flagID = 789; // Number | numeric ID of the flag

var segmentID = 789; // Number | numeric ID of the segment


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.findConstraints(flagID, segmentID, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
segmentIDNumbernumeric ID of the segment

Return type

[Constraint]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

putConstraint

Constraint putConstraint(flagID, segmentID, constraintID, body)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.ConstraintApi();

var flagID = 789; // Number | numeric ID of the flag

var segmentID = 789; // Number | numeric ID of the segment

var constraintID = 789; // Number | numeric ID of the constraint

var body = new Jsflagr.CreateConstraintRequest(); // CreateConstraintRequest | create a constraint


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putConstraint(flagID, segmentID, constraintID, body, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
segmentIDNumbernumeric ID of the segment
constraintIDNumbernumeric ID of the constraint
bodyCreateConstraintRequestcreate a constraint

Return type

Constraint

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json