This API endpoint will return a specific Department.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Departments - Allows user to view Departments. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of EquipmentSchedules.
\nSecurity
To Access this API endpoint you will need to have the following Access Policy:
- \n
- View Equipment Schedule - Allows user to view the equipment schedule. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nExample:
\n/api/v1/equipmentschedules.json?query=true&defaultfield=LocationVisible
\nIndexes
\nThe EquipmentSchedules endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the EquipmentSchedule (excluding collections) may be used to sort the EquipmentSchedules list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific EquipmentSchedule.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy
\nView Equipment Schedule\nAllows user to view the equipment schedule.
\nParameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to an EquipmentSchedule.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies:
\n- \n
Manage Equipment Schedule - Allows user to manage the equipment schedule.
\n \nManage Master Equipment Schedule - Allows user to manage the master equipment schedule.
\n \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will update an EquipmentSchedule.
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Equipment Schedule -Allows user to manage the equipment schedule.
\n \nManage Master Equipment Schedule - Allows user to manage the master equipment schedule.
\n \n
Parameters
\nBody
\nCollection of EquipmentScheduleEquipment
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will return a List of EquipmentScheduleUnavailableCodes.
\nSecurity
To Access this API endpoint you will need to have the following Access Policy:
- \n
- View Equipment Schedule Unavailable Codes - Allows user to view Equipment Schedule Unavailable Codes. \n
Filtering the Results
You may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
Usage Examples
\n/api/v1/equipmentscheduleunavailablecodes.json?query=Overhaul&defaultfield=ShortCode
\nIndexes
\nThe EquipmentScheduleUnavailableCodes endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nEquipment Schedule Unavailable Code Index
Sorting the Results
You may specify sorting via the sort query string argument. Any property of the EquipmentScheduleUnavailableCode (excluding collections) may be used to sort the EquipmentScheduleUnavailableCodes list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
Each sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific EquipmentScheduleUnavailableCode.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Equipment Schedule Unavailable Codes - Allows user to view Equipment Schedule Unavailable Codes. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Equipment Types
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Equipment Types - Allows user to view Equipment Types.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/equipmenttypes.json?query=SMV&defaultfield=
\nShortCode
\nIndexes
\nThe EquipmentTypes endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the EquipmentTypes (excluding collections) may be used to sort the EquipmentTypes list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Equipment Types.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Equipment Types - Allows user to view Equipment Types. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create a Equipment Type
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Equipment Types - Allows user to manage Equipment Types. \n
Body
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to a Equipment Types
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Equipment Types - Allows user to manage Equipment Types. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will update a Equipment Type
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Equipment Types - Allows user to manage Equipment Types. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will delete a Equipment Types.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Equipment Types - Allows user to manage Equipment Types. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a list of Equipment.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Equipment - Allows user to view Equipment. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nStartFragment
\nExample:
\n/api/v1/equipment.json?query=SMV&defaultfield=Type
\nEndFragment
\nIndexes
\nThe Equipment endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the WebhookEvent (excluding collections) may be used to sort the Equipment list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Equipment.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Equipment - Allows user to view Equipment. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create an Equipment
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Equipment - Allows user to manage Equipment. \n
Body
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will update an Equipment
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies:
\n- \n
- Manage Equipment - Allows user to manage Equipment. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- InternalServerError (500) \n
- Unauthorized (401) \n
This API endpoint will update an Equipment
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Equipment - Allows user to manage Equipment. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will delete an Equipment
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Equipment - Allows user to manage Equipment. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of Checklist Question Categories.
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Checklist Question Categories - Allows user to view Checklist Question Categories.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/ChecklistQuestionCategories.json?query=Name-1&defaultfield=Name
\nIndexes
\nThe ChecklistQuestionCategories endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the ChecklistQuestionCategories (excluding collections) may be used to sort the ChecklistQuestionCategories list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Checklist Question Categorie.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Checklist Question Categories - Allows user to view Checklist Question Categories. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create a Checklist Question Categorie
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Checklist Question Categories - Allows user to manage Checklist Question Categories. \n
Body
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
Security
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Checklist Question Categories - Allows user to manage Checklist Question Categories. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to a Checklist Question Categories
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Checklist Question Categories - Allows user to manage Checklist Question Categories. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will delete a Checklist Question Categorie.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Checklist Question Categorie - Allows user to manage Checklist Question Categorie. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a list of Forms.
\nSecurity
To Access this API endpoint you will need to have the following Access Policy
- \n
- View Forms - Allows user to view Forms. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/forms.json?query=Tasks&defaultfield=AvailableTo
\nIndexes
\nThe Forms endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the Form (excluding collections) may be used to sort the Forms list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a From
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Forms - Allows user to view Forms. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will create a From
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Forms - Allows user to manage Forms.
\nBody
\nCollection of Recurrence
\nCollection of ChecklistQuestion
\nAnswerType
\nCollection of PossibleAnswer
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nConflict (409)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will apply a patch operation to a Form
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Forms - Allows user to manage Forms.
\nParameters
\nBody
\nPotential Error Response Codes
\nInternalServerError (500)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will update a Form
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Forms - Allows user to manage Forms. \n
Parameters
\nBody
\nCollection of Recurrence
\nCollection of ChecklistQuestion
\nAnswerType
\nCollection of PossibleAnswer
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will delete a Form
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Forms - Allows user to manage Forms. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of IntegrationLogs.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Integration Logs - Allows user to view Integration Logs. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nExample:
\n/api/v1/integrationlogs.json?query=Excel&defaultfield=Source
\nIndexes
\nThe IntegrationLogs endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the IntegrationLog (excluding collections) may be used to sort the IntegrationLogs list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific IntegrationLog.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Integration Logs - Allows user to view Integration Logs. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of Smart Import Connections
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Smart Import Connections - Allows user to view Smart Import Connections.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/ShiftTimes.json?query={{value}}&defaultfield={{parameter}}
\nIndexes
\nThe Smart Import Connections endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the SmartImportConnections (excluding collections) may be used to sort the SmartImportConnections list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific SmartImportConnection.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Smart Import Connections - Allows user to view Smart Import Connections. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Smart Import Destinations
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Smart Import Destinations - Allows user to view Smart Import Destinations.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/ShortIntervalControls.json?query=UserLeave
&defaultfield=Destination
Indexes
\nThe SmartImportDestinations endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the Smart Import Destinations (excluding collections) may be used to sort the Smart Import Destinations list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Smart Import Destination.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Smart Import Destinations - Allows user to view Smart Import Destinations. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of Integrations.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Integrations - Allows user to see the Integrations between Fewzion and other systems/resources \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found here.
\nUsage Examples
\n/api/v1/integrations.json?query=Mainstay&defaultfield=Type
\nIndexes
\nThe Integrations endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the Integration (excluding collections) may be used to sort the Integrations list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Integration.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Integrations - Allows user to see the Integrations between Fewzion and other systems/resources \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create a Integration
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources.
\n \nCreate Smart Import Integrations - Allows user to add Integrations between Fewzion and other systems/resources.
\n \n
Body
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
Security
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources.
\n \nCreate Smart Import Integrations - Allows user to add Integrations between Fewzion and other systems/resources.
\n \n
Body
\nCollection of SmartImportMapping
\nCollection of SmartImportLookup
\nCollection of SmartImportCronSchedule
\nSmartImportWindow
\nPotential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Security
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Run Smart Import Integrations - Allows user to run Integrations between Fewzion and other systems/resources. \n
Potential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Security
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources.
\n \nCreate Smart Import Integrations - Allows user to add Integrations between Fewzion and other systems/resources.
\n \n
Body
\nCollection of SmartImportMapping
\nCollection of SmartImportLookup
\nCollection of SmartImportCronSchedule
\nSmartImportWindow
\nPotential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will apply a patch operation to a Integration
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- InternalServerError (500) \n
- Unauthorized (401) \n
Security
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Sync Mainstay Integration - Allows user to sync mainstay integrations. \n
Parameters
\nPotential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will download an Integration icon
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Integrations - Allows user to see the Integrations between Fewzion and other systems/resources \n
Parameters
\nPotential Error Response Codes
\nBadRequest (400)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Security
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources.
\n \nCreate Smart Import Integrations - Allows user to add Integrations between Fewzion and other systems/resources.
\n \n
Parameters
\nPotential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Security
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
Manage Integrations - Allows user to edit and remove Integrations between Fewzion and other systems/resources.
\n \nCreate Smart Import Integrations - Allows user to add Integrations between Fewzion and other systems/resources.
\n \n
Body
\nCollection of SmartImportMapping
\nCollection of SmartImportLookup
\nCollection of SmartImportCronSchedule
\nSmartImportWindow
\nPotential Error Response Codes
\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Issues.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Issues - Allows user to view Issues. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nExample:
\nStartFragmentStartFragment
\n/api/v1/issues.json?query=Scoped&defaultfield=Status
\nEndFragmeFrag
\nIndexes
\nThe Issues endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the Issue (excluding collections) may be used to sort the Issues list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return an Issue.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy: View Issues - allows user to view Issues.
\nParameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create an Issue
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Issues - allows user to manage Issues. \n
Body
\nCollection of IssueAction
\nIssueActionStatus
\nThe set of statuses that can be taken by an action.\nPossible enumeration values:
\nIssueStatus\nThe set of statuses that can be taken by a issue.\nPossible enumeration values:
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to an Issue
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy: Manage Issues - allows user to manage Issues.
\nParameters
\nBody
\nPotential Error Response Codes
\n- \n
- InternalServerError (500) \n
- Unauthorized (401) \n
This API endpoint will update a Issue
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy: Manage Issues - allows user to manage Issues.
\nParameters
\nBody
\nCollection of IssueAction
\nIssueActionStatus
\nThe set of statuses that can be taken by an action.\nPossible enumeration values:
\nIssueStatus\nThe set of statuses that can be taken by a issue.\nPossible enumeration values:
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Folder with requests to get, add and edit issues
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will create a StandardTask
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies:
\n- \n
Manage Standard Tasks - Allows the user to add, edit and delete Standard Tasks for any Process on the Planning Board. This policy is intended to be used in conjuction with the View Standard Tasks policy.
\n \nManage Accessible Standard Tasks - Allows the user to add, edit and delete Standard Tasks for Processes on the Planning Board they have access to. This policy is intended to be used in conjuction with the View Standard Tasks policy.
\n \n
Body
\nCollection of RequiredPerson
\nCollection of RequiredEquipment
\nCollection of AssignedEquipment
\nDue
\nCollection of TaskLocation
\nCollection of Attachment
\nAttachmentType
\nCollection of AttachmentTag
\nCollection of RelatedAttachment
\nCollection of AppliedTag
\nCollection of ComplianceBreach
\nComplianceBreachStatus
\nCollection of TaskChecklistQuestion
\nAnswerType
\nCollection of TaskChecklistQuestionPossibleAnswer
\nCollection of Recurrence
\nCollection of TaskForm
\nCollection of TaskFormChecklist
\nCollection of TaskFormAuditRecord
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will return a List of StandardJobs.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\nView Standard Jobs - Allows the user to view Standard Jobs.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/standardjobs.json?query=2nd wave SMV&defaultfield=Name
\nIndexes
\nThe StandardJobs endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
You may specify sorting via the sort query string argument. Any property of the StandardJob (excluding collections) may be used to sort the StandardJobs list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
Each sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return all the standard tasks that live on standard jobs.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Standard Jobs - Allows the user to view Standard Jobs. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found here.
\nUsage Examples
\n/api/v1/standardjobs.json/GetStandardTasks?query=1S
&defaultfield=Priority
Indexes
\nThe StandardTasks endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the StandardTask (excluding collections) may be used to sort the StandardTasks list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will create a StandardJob
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Standard Jobs - Allows the user to add, edit and delete Standard Jobs. \n
Body
\nCollection of StandardJobStandardTask
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nConflict (409)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will copy a standard job and its standard tasks.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Standard Jobs - Allows the user to add, edit and delete Standard Jobs. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific StandardJob.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Standard Jobs - Allows the user to view Standard Jobs. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will update a StandardJob
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Standard Jobs - Allows the user to add, edit and delete Standard Jobs. \n
Parameters
\nBody
\nCollection of StandardJobStandardTask
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will apply a patch operation to a Standard Job
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Standard Jobs - Allows user to manage Standard Jobs. \n
Parameters
\nBody
\nPotential Error Response Codes
\nInternalServerError (500)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will schedule a standard job.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies:
\n- \n
Manage Standard Jobs - Allows the user to add, edit and delete Standard Jobs.
\n \nSchedule Standard Jobs - Allows the user schedule Standard Jobs.
\n \n
Parameters
\nCollection of Task
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will delete a StandardJob
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Standard Jobs - Allows the user to add, edit and delete Standard Jobs. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Jobs
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Jobs - Allows user to view Jobs.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/jobs.json?query=MST&defaultfield=Type
\nIndexes
\nThe Jobs endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the Jobs (excluding collections) may be used to sort the Jobs list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Job.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Job - Allows user to view Job. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create a Job
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Jobs - Allows user to manage Jobs. \n
Body
\nTargetCollection
\nTaskCollection
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to a Job
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Jobs - Allows user to manage Jobs. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will update a Job
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Jobs - Allows user to manage Jobs. \n
Parameters
\nBody
\nBody
\nTargetCollection
\nTaskCollection
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will delete a Jobs.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Jobs - Allows user to manage Jobs. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of LocationTypes.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Location Types - Allows user to view Location Types. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/locationtypes.json?query={{value}}&defaultfield={{parameter}}
\nIndexes
\nThe LocationTypes endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the LocationType (excluding collections) may be used to sort the LocationTypes list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\nNotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific LocationType.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- View Location Types - Allows user to view Location Types. \n
Parameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Locations.
\nSecurity
To Access this API endpoint you will need to have the following Access Policy:
- \n
- View Locations - Allows user to view Locations. \n
Filtering the Results
You may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
Example:
\nStartFragment
\n/api/v1/Locations.json?query=Zone3A&defaultfield=ShortCode
\nIndexes
The Locations endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
Sorting the Results
You may specify sorting via the sort query string argument. Any property of the Location (excluding collections) may be used to sort the Locations list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
Each sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Location.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Locations - Allows user to view Locations. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will create a Location.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Locations - Allows user to manage Locations. \n
Parameters
\nBody
\nCollection of AppliedTag
\nCollection of RelatedLocation
\nCollection of LocationSmartImportProcess
\nCollection of LocationStatus
\nLocationStatusKind
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to a Location.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Locations - Allows user to manage Locations. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will create a Location.
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Locations - Allows user to manage Locations. \n
Parameters
\nBody
\nCollection of AppliedTag
\nCollection of RelatedLocation
\nCollection of LocationSmartImportProcess
\nCollection of LocationStatus
\nLocationStatusKind
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will delete a Location.
\nPLEASE NOTE: This endpoint does not actually delete the indicated document, but instead flags it as deleted.
\nRecords flagged as deleted are not returned by the GET endpoint by default. Pass 'includedeleted=true' on the query string to retrieve records flagged as deleted
\nSecurity\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- Manage Locations - Allows user to manage Locations. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return an access token for selected user
\nParameters
\n","urlObject":{"path":["Client","identity","connect","token"],"host":["{{Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d06d0082-ce42-4b4e-bc10-3436807ec7c0"}],"id":"adb96eaf-8ba6-4ae7-9d2d-22bc01cd129b","_postman_id":"adb96eaf-8ba6-4ae7-9d2d-22bc01cd129b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a process plan report exported to PDF.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Process Plan Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Shift Plan Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Shift Plan Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"1/1
Mon 04 Oct | Tue 05 Oct | Wed 06 Oct |
05:00 | 06:00 | 07:00 | 08:00 | 09:00 | 10:00 | 11:00 | 12:00 | 13:00 | 14:00 | 15:00 | 16:00 | 17:00 | 18:00 | 19:00 | 20:00 | 21:00 | 22:00 | 23:00 | 00:00 | 01:00 | 02:00 | 03:00 | 04:00 | 05:00 | 06:00 | 07:00 | 08:00 | 09:00 | 10:00 | 11:00 | 12:00 | 13:00 | 14:00 | 15:00 | 16:00 | 17:00 | 18:00 | 19:00 | 20:00 | 21:00 | 22:00 | 23:00 | 00:00 | 01:00 | 02:00 | 03:00 | 04:00 | 05:00 | 06:00 | 07:00 | 08:00 |
Starting: Day shiftFixed Maintenance
Contractor
Site-wide and Critical
Meetings
Concentrator
Services
*Unknown
*Unknown
Mobile Maintenance
Production
*Unknown
*Unknown
Development\\\">\\u3000
Contractor
Site-wide and Critical
Meetings
Concentrator
Services
*Unknown
*Unknown
Mobile Maintenance
Production
*Unknown
*Unknown
Development
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Production
Services
*Unknown
*Unknown
*Unknown
*Unknown
Development
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Production
Services
*Unknown
*Unknown
*Unknown
*Unknown
Development
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Services
Production
*Unknown
*Unknown
*Unknown
*Unknown
Development
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Services
Production
*Unknown
*Unknown
*Unknown
*Unknown
Development
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Production
Services
*Unknown
*Unknown
*Unknown
*Unknown
Development
Ending: Night shiftFixed Maintenance
Contractor
Site-wide and Critical
Meetings
Concentrator
Mobile Maintenance
Production
Services
*Unknown
*Unknown
*Unknown
*Unknown
Development\\\">\\u3000
Re-entry DECA -10 DRIFT Re-entry DECA -10 DRIFT Prepare face DECA -10 DRIFT Prepare face DECA -10 DRIFT |
Re-entry DECA -10 DRIFT Re-entry DECA -10 DRIFT Prepare face DECA -10 DRIFT Prepare face DECA -10 DRIFT |
![\\\"Shadow](\\\"resources/desktop/images/shared/shadow-task.png\\\")
![\\\"Accept\\\"](\\\"resources/desktop/images/shared/accept.png\\\")
![\\\"Reject\\\"](\\\"resources/desktop/images/shared/reject.png\\\")
This API endpoint will export scheduler report
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Bryntum Report - Allows user to export report.
\nBody
\nhtmlCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will donload export scheduler report
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Bryntum Report - Allows user to export report.
\nParameters
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Daily Schedule Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Daily Schedule Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Task List Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Task List Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Shift Undermanagers Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Shift Undermanagers Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Daily Schedule Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nDaily Schedule Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Daily Schedule Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nDaily Schedule Report - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"1/1
Monday 4th Oct 2021 - DAY |
4:00 | 5:00 | 6:00 | 7:00 | 8:00 | 9:00 | 10:00 | 11:00 | 12:00 | 13:00 | 14:00 | 15:00 | 16:00 | 17:00 | 18:00 | 19:00 | 20:00 | 21:00 | 22:00 |
This API endpoint will export Gantt View report
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Bryntum Report - Allows user to export report.
\nBody
\nhtmlCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will donload exported Gantt View report
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrint Bryntum Report - Allows user to export report.
\nParameters
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will print Equipment Schedule Report.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nPrintEquipmentScheduleReport - Allows user to print report.
\nParameters
\nparametersCollection
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of ReportingCalendars.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\n- \n
- View Reporting Calendars - Allows user to view Reporting Calendars. \n
Filtering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/reportingcalendars.json?query=AAGroup&defaultfield=Group
\nIndexes
\nThe ReportingCalendars endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the ReportingCalendar (excluding collections) may be used to sort the ReportingCalendars list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nResponse
\nPotential Error Response Codes
NotFound (404)
BadRequest (400)
Unauthorized (401)
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will create a ReportingCalendars
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Reporting Calendars - Allows user to manage Reporting Calendars
\nBody
\nCollection of ReportingCalendarItem
\nCollection of ReportingCalendarPeriod
\nCollection of ReportingCalendarProcess
\nCollection of ReportingCalendarTarget
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nConflict (409)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific ReportingCalendar.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nView Reporting Calendars - Allows user to view Reporting Calendars.
\nParameters
\nPotential Error Response Codes\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will update a reportingcalendars
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Reporting Calendars - Allows user to manage Reporting Calendars.
\nParameters
\nBody
\nCollection of ReportingCalendarItem
\nCollection of ReportingCalendarPeriod
\nCollection of ReportingCalendarProcess
\nCollection of ReportingCalendarTarget
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will apply a patch operation to a ReportingCalendar
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Reporting Calendars - Allows user to manage Reporting Calendars.
\nParameters
\nBody
\nPotential Error Response Codes
\nInternalServerError (500)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will delete a ReportingCalendars
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy:
\nManage Reporting Calendars - Allows user to manage Reporting Calendars.
\nParameters
\nPotential Error Response Codes
\nNotFound (404)\nBadRequest (400)\nUnauthorized (401)
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a List of Report Occurrences
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Report Occurrences - Allows user to view Report Occurrences.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nUsage Examples
\n/api/v1/reportoccurrences.json?query=ReportOccurrences-16897&defaultfield=Id
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will return a specific Report Occurrences.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Report Occurrences - Allows user to view Report Occurrences. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will return a List of Reporting Rules
\nSecurity
\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\nView Reporting Rules - Allows user to view Reporting Rules.
\nFiltering the Results
\nYou may specify filtering criteria via the ‘query’ query string argument. Details about the syntax is found in Querying section.
\nUsage Examples
\n/api/v1/ReportingRules.json?query=DailyActualsReport
&defaultfield=ReportType
Indexes
\nThe ReportingRules endpoint has 1 predefined index, which is used automatically by the API based on the filter criteria that you specify via the filter query string argument. The API adds the X-fewzion-index-used header to the response to assist you during the build phase of the integration, so that you can tell which index the API chose.
\nSorting the Results
\nYou may specify sorting via the sort query string argument. Any property of the ReportingRules (excluding collections) may be used to sort the ReportingRules list returned by this endpoint. The sort has to be arranged as a collection of sort conditions.
\nEach sort condition is made of the property name and the direction, where the direction may be either \"ASC\" or \"DESC\".
\nPlease note that if you are using an index, you should first consider any default sorting provided by the index before applying sorting via this method.
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
Result are limited to 10240 records
\nQuerying
\nBy providing the “query” query string argument you can provide a query to apply to results. Here are some query examples demonstrating the query syntax.
\nKeyword matching:
\nWildcard matching:
\nNote that Lucene doesn't support using a * symbol as the first character of a search.
\n@in:
\nYou can specify any number of parameters that you are looking for. The , (comma) character is a separator of the values.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This API endpoint will create a Reporting Rule
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Reporting Rule - Allows user to manage Reporting Rule. \n
Body
\nRulesCollections
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will return a specific Reporting Rule.
\nSecurity\nTo Access this API endpoint you will need to have at least one of the following Access Policies
\n- \n
- View Reporting Rules - Allows user to view Reporting Rules. \n
Parameters
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Unauthorized (401) \n
This API endpoint will update a Reporting Rules
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Reporting Rules - Allows user to manage Reporting Rules. \n
Parameters
\nBody
\nRulesCollections
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will apply a patch operation to a Reporting Rules.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Reporting Rules - Allows user to manage Reporting Rules. \n
Parameters
\nBody
\nPotential Error Response Codes
\n- \n
- NotFound (404) \n
- BadRequest (400) \n
- Conflict (409) \n
- Unauthorized (401) \n
This API endpoint will delete a Reporting Rules.
\nSecurity
\nTo Access this API endpoint you will need to have the following Access Policy
\n- \n
- Manage Leave Approval Models - Allows user to manage Reporting Rules. \n
Parameters
\n