sync.slave

Available methods

Description

Contains methods to set up information about allowed-"slaves", for use on the "master" side of ISS

Namespace:

sync.slave

Method: create

HTTP POST

Description:

Create a new Slave, known to this Master.

Parameters:

  • string sessionKey

  • string slaveFqdn - Slave’s fully-qualified domain name

  • boolean isEnabled - Let this slave talk to us?

  • boolean allowAllOrgs - Export all our orgs to this slave?

Returns:

  • * struct IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: delete

HTTP POST

Description:

Remove the specified Slave

Parameters:

  • string sessionKey

  • int slaveId - ID of the Slave to remove

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getAllowedOrgs

HTTP GET

Description:

Get all orgs this Master is willing to export to the specified Slave

Parameters:

  • string sessionKey

  • int slaveId - Id of the desired Slave

Returns:

  • int array ids of allowed organizations

Method: getSlave

HTTP GET

Description:

Find a Slave by specifying its ID

Parameters:

  • string sessionKey

  • int slaveId - ID of the desired Slave

Returns:

  • * struct IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: getSlaveByName

HTTP GET

Description:

Find a Slave by specifying its Fully-Qualified Domain Name

Parameters:

  • string sessionKey

  • string slaveFqdn - Domain-name of the desired Slave

Returns:

  • * struct IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: getSlaves

HTTP GET

Description:

Get all the Slaves this Master knows about

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: setAllowedOrgs

HTTP POST

Description:

Set the orgs this Master is willing to export to the specified Slave

Parameters:

  • string sessionKey

  • int slaveId - ID of the desired Slave

  • int array orgIds - List of org-ids we’re willing to export

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: update

HTTP POST

Description:

Updates attributes of the specified Slave

Parameters:

  • string sessionKey

  • int slaveId - ID of the Slave to update

  • string slaveFqdn - Slave’s fully-qualified domain name

  • boolean isEnabled - Let this slave talk to us?

  • boolean allowAllOrgs - Export all our orgs to this Slave?

Returns:

  • * struct IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"