Search
Use this resource to search for text across IBM Blueworks Live artifacts.
Method summary
| HTTP Method | Path | Description |
|---|---|---|
| POST | /scr/api/Search | Searches for text across IBM Blueworks Live artifacts. |
POST /scr/api/Search
- Description
- Use this method to search for text across IBM Blueworks Live artifacts.
- Resource information
-
Requirements Description Response format JSON Requires authentication Yes. The user must have at least participant access to the process. Supports OAuth 2 client credentials Yes, using a User Service ID containing Artifact Reporting Category Rate limited Not yet
- Parameters
-
Name Location Description Required Type X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String returnFields Query The list of fields to return. Valid values are output,business_owner,problem,input,customer,supplier,system,expert,participant,external_participant,tag,cost,work_time,wait_time,decision_expert,kpis,business_motivation,decision_how_often_made,decision_volume,decision_how_often_updated,decision_frequency,decision_how_much_time,decision_latency,sources,decision_input,decision_output,decision_business_owner, and the exact name of any custom property. Pass in the value of*to return all properties; the case does not matter in this instance.Note: Theactivity_name,milestone_name,process_name,space_name,decision_name,sub_process_name,decision_diagram_name,decision_item_name, andevent_nameare always returned if they match.Yes Comma-separated list of text strings searchFieldName Query The single field to search on. Valid values are activity_name,milestone_name,process_name,space_name,output,business_owner,problem,input,customer,supplier,system,expert,participant,external_participant,tag,cost,work_time,wait_time,decision_expert,kpis,business_motivation,decision_how_often_made,decision_volume,decision_how_often_updated,decision_frequency,decision_how_much_time,decision_latency,sources,decision_input,decision_output,decision_business_owner,decision_name,event_name,attached_event_name,sub_process_name, and the exact name of any custom property. This field is not case sensitive.Note: Searching foractivity_namesearches foractivity_name,sub_process_name,decision_name, andevent_name.Yes String searchValue Query The value to search for. When the searchFieldName is decision_volume,decision_frequency, ordecision_latency, search for one of the values:LowMediumHigh
Yes String version Query The version of the requested API. Possible values are 2019121420150930(deprecated)20120130(deprecated)20111217(deprecated)
Yes String includeArchived Query The default value is false. Set the value totrueto include archived data in the search.No Boolean topSpacesOnly Query Whether only artifacts belonging to top-level spaces should be included in the output. If the value is true, only artifacts belonging to top-level spaces are shown; if it isfalse, all artifacts are shown. This filter is only useful when thesearchFieldNameis eitherspace_nameortag; searching by any other field excludes the child spaces by default.No Boolean
- Response
- The data is returned as a list of spaces:
- Each
spacecontains lists ofprocesses. - Each
processa list ofmilestones. - Each
milestonea list ofactivities.
spaces, can contain the specified properties in the returnFields parameter.- Example input
- The following example returns specific fields:
- Using User Service ID OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/Search?version=20191214&searchValue=Initial%20Hire&searchFieldName=input&returnFields=output,business_owner,problem" - Using Service ID OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/Search?version=20191214&searchValue=Initial%20Hire&searchFieldName=input&returnFields=output,business_owner,problem" - Using Service ID OAuth 2 client credentials with user
context:
curl -i -H "Authorization: Bearer access_token" "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/Search?version=20191214&searchValue=Initial%20Hire&searchFieldName=input&returnFields=output,business_owner,problem"
- Using User Service ID OAuth 2 client
credentials:
- Example output
- Returning all
fields:
{ "spaces": [ { "id": "d0074", "name": "Process Examples", "processes": [ { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "1600" } ], "customers": [ { "id": "d001c", "name": "Candidate" } ], "cycleTime": [ { "name": "40320" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d00f9", "inputs": [ { "id": "d006b", "name": "Open Position" } ], "milestones": [ { "activities": [ { "cycleTime": [ { "name": "30" } ], "id": "d03fa", "name": "Go To Workspace", "participants": [ { "id": "d002a", "name": "Candidate" } ] }, { "business owners": [ { "id": "d0051", "name": "Facilities Team" } ], "cycleTime": [ { "name": "30" } ], "experts": [ { "id": "d0051", "name": "Facilities Team" } ], "id": "d03f8", "inputs": [ { "id": "d006a", "name": "Completed Workspace Request" } ], "name": "Obtain Equipment", "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] }, { "business owners": [ { "id": "d0051", "name": "Facilities Team" } ], "cycleTime": [ { "name": "15" } ], "experts": [ { "id": "d0051", "name": "Facilities Team" } ], "id": "d03f6", "inputs": [ { "id": "d0069", "name": "Completed Access Badge Request" } ], "name": "Obtain Access Badge", "outputs": [ { "id": "d0058", "name": "Access Badge" } ], "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d0029", "name": "Miskeyed Employee Data" }, { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] }, { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "60" } ], "id": "d03f4", "name": "Meet Manager", "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] } ], "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "100" } ], "customers": [ { "id": "d001c", "name": "Candidate" } ], "cycleTime": [ { "name": "1440" } ], "id": "d0121", "name": "Begin Work", "participants": [ { "id": "d002a", "name": "Candidate" } ], "suppliers": [ { "id": "d001f", "name": "Hiring Manager" } ] }, { "activities": [ { "cycleTime": [ { "name": "2880" } ], "id": "d03a4", "name": "Submit Forms To HR", "participants": [ { "id": "d002a", "name": "Candidate" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "cycleTime": [ { "name": "120" } ], "id": "d03a2", "name": "Complete Benefits Forms", "participants": [ { "id": "d002a", "name": "Candidate" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "cycleTime": [ { "name": "30" } ], "id": "d03a0", "name": "Complete Tax Forms", "participants": [ { "id": "d002a", "name": "Candidate" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "cycleTime": [ { "name": "30" } ], "experts": [ { "id": "d005d", "name": "Payroll" } ], "id": "d039e", "name": "Complete I-9", "outputs": [ { "id": "d005e", "name": "Completed I-9 Form" } ], "participants": [ { "id": "d002a", "name": "Candidate" } ], "problems": [ { "id": "d005f", "name": "Employee does not have proper documents" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "cycleTime": [ { "name": "60" } ], "id": "d0345", "inputs": [ { "id": "d0062", "name": "Benefits Enrollments Forms" }, { "id": "d0061", "name": "Tax Forms" }, { "id": "d0060", "name": "I-9 Form" } ], "name": "Complete Forms", "outputs": [ { "id": "d0063", "name": "Completed Tax Forms" }, { "id": "d005e", "name": "Completed I-9 Form" }, { "id": "d0064", "name": "Completed Benefits Enrollments Forms" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "120" } ], "id": "d0343", "inputs": [ { "id": "d0009", "name": "Orientation CD" } ], "name": "Watch Orientation CD", "participants": [ { "id": "d002a", "name": "Candidate" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0341", "inputs": [ { "id": "d000a", "name": "Employee Address" } ], "linkedProcessIds": [ "d009f" ], "name": "Provide Orientation CD", "outputs": [ { "id": "d0009", "name": "Orientation CD" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "125" } ], "cycleTime": [ { "name": "180" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d033f", "name": "Benefits Overview Class", "participants": [ { "id": "d002a", "name": "Candidate" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "275" } ], "cycleTime": [ { "name": "240" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d033d", "name": "New Hire Orientation Class", "participants": [ { "id": "d002a", "name": "Candidate" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d033b", "inputs": [ { "id": "d005b", "name": "Orientation location" } ], "name": "Orientation Location", "outputs": [ { "id": "d005c", "name": "Onsite or Offsite decision" } ], "participants": [ { "id": "d0006", "name": "HR Docs Team" } ] } ], "business owners": [ { "id": "d0002", "name": "Human Resources" }, { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "400" } ], "customers": [ { "id": "d001c", "name": "Candidate" } ], "cycleTime": [ { "name": "1440" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d011f", "inputs": [ { "id": "d0065", "name": "New hire in HR records" } ], "name": "Orientation", "outputs": [ { "id": "d0066", "name": "Completed Benefits Forms" }, { "id": "d0067", "name": "Completed Stock Grant forms" } ], "suppliers": [ { "id": "d0068", "name": "Human Resources" }, { "id": "d001f", "name": "Hiring Manager" } ] }, { "activities": [ { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "30" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d02b5", "inputs": [ { "id": "d000a", "name": "Employee Address" }, { "id": "d0059", "name": "Cleared Checklist" } ], "name": "Set Employee Status To Active", "outputs": [ { "id": "d005a", "name": "New Hire Package" } ], "participants": [ { "id": "d0001", "name": "HR Specialist" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" }, { "id": "d004a", "name": "HR Oracle System" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "50" } ], "cycleTime": [ { "name": "60" } ], "experts": [ { "id": "d0051", "name": "Facilities Team" } ], "id": "d02b3", "inputs": [ { "id": "d0057", "name": "Site Access Restrictions (times & locations)" }, { "id": "d0056", "name": "Approval for Site Access" }, { "id": "d0004", "name": "Level" } ], "name": "Request Access Badge", "outputs": [ { "id": "d0058", "name": "Access Badge" } ], "participants": [ { "id": "d0051", "name": "Facilities Team" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "2880" } ], "experts": [ { "id": "d0051", "name": "Facilities Team" } ], "id": "d02b1", "inputs": [ { "id": "d0052", "name": "Department" }, { "id": "d0053", "name": "Level (office or cube)" }, { "id": "d0054", "name": "Special Needs" } ], "name": "Request Workspace", "outputs": [ { "id": "d0055", "name": "Location of office\/cube" } ], "participants": [ { "id": "d0051", "name": "Facilities Team" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ], "systems": [ { "id": "d0050", "name": "IT Provisioning Portal" } ] }, { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "2000" } ], "cycleTime": [ { "name": "1440" } ], "experts": [ { "id": "d0007", "name": "IT Support" } ], "id": "d02af", "inputs": [ { "id": "d004e", "name": "Mobile phone - include statement about whether Blackberry needed" }, { "id": "d004c", "name": "Special Software Needs (e.g. Graphic Design package)" }, { "id": "d004b", "name": "Job Title" }, { "id": "d004d", "name": "Laptop or Desktop Computer" } ], "name": "Request Equipment", "outputs": [ { "id": "d004f", "name": "Order Confirmation Email with Delivery Date" } ], "participants": [ { "id": "d0001", "name": "HR Specialist" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ], "systems": [ { "id": "d0050", "name": "IT Provisioning Portal" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "120" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d02ad", "inputs": [ { "id": "d0045", "name": "Emergency Contact Info" }, { "id": "d0046", "name": "Salary" }, { "id": "d0044", "name": "SSN" }, { "id": "d0048", "name": "Banking information for Direct Deposit" }, { "id": "d000a", "name": "Employee Address" }, { "id": "d0047", "name": "Stock Grants" } ], "name": "Input Employee Information into Database", "outputs": [ { "id": "d0049", "name": "Employee Number" } ], "participants": [ { "id": "d0001", "name": "HR Specialist" } ], "problems": [ { "id": "d0029", "name": "Miskeyed Employee Data" } ], "systems": [ { "id": "d004a", "name": "HR Oracle System" } ] } ], "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "2500" } ], "customers": [ { "id": "d001f", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "5760" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d011d", "inputs": [ { "id": "d0040", "name": "Signed Offer Letter" } ], "name": "Add Candidate To HR Records", "outputs": [ { "id": "d005a", "name": "New Hire Package" } ], "suppliers": [ { "id": "d001c", "name": "Candidate" } ] }, { "activities": [ { "business owners": [ { "id": "d003e", "name": "hg" } ], "cycleTime": [ { "name": "10080" } ], "experts": [ { "id": "d003f", "name": "Audit control" } ], "id": "d0258", "inputs": [ { "id": "d0019", "name": "Offer Letter" } ], "name": "Accept Offer", "outputs": [ { "id": "d0040", "name": "Signed Offer Letter" } ], "participants": [ { "id": "d002a", "name": "Candidate" } ], "problems": [ { "id": "d0042", "name": "Candidate Takes Longer Than 1 Week To Respond" } ], "systems": [ { "id": "d0041", "name": "DB2" } ] }, { "cost": [ { "name": "25" } ], "cycleTime": [ { "name": "1440" } ], "id": "d0256", "name": "Transmit Offer Letter", "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d003d", "name": "Candidate uncomfortable with lag in sending offer letter" }, { "id": "d003c", "name": "Lag in offer letter delays processing time for HR" }, { "id": "d0029", "name": "Miskeyed Employee Data" } ] }, { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "240" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0254", "inputs": [ { "id": "d003a", "name": "Final Compensation Package" } ], "name": "Create Offer Letter", "outputs": [ { "id": "d0019", "name": "Offer Letter" } ], "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d003b", "name": "Manager doesn't always write letter quickly (no standard format)" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] } ], "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "50" } ], "customers": [ { "id": "d001c", "name": "Candidate" } ], "cycleTime": [ { "name": "20160" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d011b", "inputs": [ { "id": "d0035", "name": "Approval of Hiring Manager to hire" } ], "name": "Offer", "outputs": [ { "id": "d0043", "name": "Accepted Offer" } ], "participants": [ { "id": "d002a", "name": "Candidate" } ], "suppliers": [ { "id": "d001f", "name": "Hiring Manager" } ] }, { "activities": [ { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "1440" } ], "experts": [ { "id": "d002f", "name": "Screening Firm" } ], "id": "d0203", "inputs": [ { "id": "d002e", "name": "Sample" } ], "name": "Process Sample", "outputs": [ { "id": "d0030", "name": "Toxicology Report" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "60" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0201", "inputs": [ { "id": "d002b", "name": "Candidate Instructions" }, { "id": "d002c", "name": "Schedule time for visit" }, { "id": "d002d", "name": "Directions to Screening Firm" } ], "name": "Screening Visit", "outputs": [ { "id": "d002e", "name": "Sample" } ], "participants": [ { "id": "d002a", "name": "Candidate" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d01c5", "inputs": [ { "id": "d0024", "name": "Pass\/Fail Notice" } ], "name": "Review Results", "outputs": [ { "id": "d0025", "name": "Summary Review for Hiring Manager" } ], "participants": [ { "id": "d000c", "name": "Recruiter" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d01c3", "inputs": [ { "id": "d0022", "name": "Release Form signed by Candidate" } ], "name": "Public Record Search", "outputs": [ { "id": "d0023", "name": "Criminal Check Results" } ], "participants": [ { "id": "d0021", "name": "Background Check Vendor" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cycleTime": [ { "name": "60" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d01ab", "inputs": [ { "id": "d0025", "name": "Summary Review for Hiring Manager" }, { "id": "d0033", "name": "Pass\/Fail Notice (Criminal)" }, { "id": "d0034", "name": "Pass\/Fail Notice (Drug Screen)" } ], "name": "Review Results", "outputs": [ { "id": "d0035", "name": "Approval of Hiring Manager to hire" } ], "participants": [ { "id": "d000d", "name": "Hiring Manager" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "850" } ], "cycleTime": [ { "name": "1440" } ], "experts": [ { "id": "d002f", "name": "Screening Firm" } ], "id": "d01a9", "inputs": [ { "id": "d0022", "name": "Release Form signed by Candidate" } ], "name": "Drug Screen", "outputs": [ { "id": "d0030", "name": "Toxicology Report" } ], "problems": [ { "id": "d0032", "name": "Delays in communication results in delays in screening" } ], "systems": [ { "id": "d0031", "name": "ADP HR Portal" } ] }, { "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "300" } ], "cycleTime": [ { "name": "2880" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d01a7", "inputs": [ { "id": "d0026", "name": "Request for Background Check" }, { "id": "d0022", "name": "Release Form signed by Candidate" }, { "id": "d0027", "name": "Approval from HR for processing costs" } ], "name": "Criminal Record Check", "outputs": [ { "id": "d0025", "name": "Summary Review for Hiring Manager" }, { "id": "d0024", "name": "Pass\/Fail Notice" } ], "problems": [ { "id": "d0029", "name": "Miskeyed Employee Data" } ], "systems": [ { "id": "d0028", "name": "ARS" } ] } ], "business owners": [ { "id": "d0002", "name": "Human Resources" } ], "cost": [ { "name": "1200" } ], "customers": [ { "id": "d001f", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "4320" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0119", "inputs": [ { "id": "d0022", "name": "Release Form signed by Candidate" }, { "id": "d001e", "name": "Background Check Forms" }, { "id": "d0027", "name": "Approval from HR for processing costs" } ], "name": "Background Check", "outputs": [ { "id": "d0037", "name": "Cleared Drug Screen" }, { "id": "d0038", "name": "Approval of Human Resources" }, { "id": "d0036", "name": "Cleared Criminal Record Check" } ], "participants": [ { "id": "d000c", "name": "Recruiter" } ], "problems": [ { "id": "d0039", "name": "Turn around times create risk for offer" } ], "suppliers": [ { "id": "d001c", "name": "Candidate" } ] }, { "activities": [ { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "15" } ], "experts": [ { "id": "d0002", "name": "Human Resources" }, { "id": "d000d", "name": "Hiring Manager" } ], "id": "d0139", "inputs": [ { "id": "d0017", "name": "Manager calendar" }, { "id": "d0018", "name": "Requested start date from candidate" }, { "id": "d0019", "name": "Offer Letter" } ], "name": "Establish Start Date", "outputs": [ { "id": "d001a", "name": "Start Date" } ], "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d001b", "name": "Manager is not always available on requested start date" } ] }, { "business owners": [ { "id": "d0011", "name": "Finance" }, { "id": "d000d", "name": "Hiring Manager" } ], "cycleTime": [ { "name": "180" } ], "experts": [ { "id": "d0002", "name": "Human Resources" }, { "id": "d0011", "name": "Finance" }, { "id": "d000d", "name": "Hiring Manager" } ], "id": "d0137", "inputs": [ { "id": "d0013", "name": "Acceptable Stock Grant Range from Finance" }, { "id": "d0014", "name": "Internal Department Budget" }, { "id": "d0012", "name": "Acceptable Salary Range from Finance" } ], "name": "Establish Compensation Package", "outputs": [ { "id": "d0015", "name": "Compensation package" } ], "participants": [ { "id": "d000d", "name": "Hiring Manager" } ], "problems": [ { "id": "d0016", "name": "Didn't receive range, instead receive initial level from Finance" } ] }, { "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0135", "inputs": [ { "id": "d000e", "name": "Final Hire Decision" } ], "name": "Inform Recruiter", "outputs": [ { "id": "d000f", "name": "Requisition Close Email to Recruiter" } ], "participants": [ { "id": "d000c", "name": "Recruiter" } ], "problems": [ { "id": "d0010", "name": "48 Hour Lag In New Employee Data Feed" } ] } ], "business owners": [ { "id": "d000d", "name": "Hiring Manager" } ], "cost": [ { "name": "500" } ], "customers": [ { "id": "d001c", "name": "Candidate" } ], "cycleTime": [ { "name": "5760" } ], "experts": [ { "id": "d0002", "name": "Human Resources" } ], "id": "d0117", "inputs": [ { "id": "d001d", "name": "Initial Hire Decision" } ], "name": "Select Candidate", "outputs": [ { "id": "d001e", "name": "Background Check Forms" } ], "suppliers": [ { "id": "d0020", "name": "Recruiter" }, { "id": "d001f", "name": "Hiring Manager" } ] } ], "name": "Hiring - Onboarding", "outputs": [ { "id": "d006c", "name": "Filled Position" } ], "suppliers": [ { "id": "d001f", "name": "Hiring Manager" } ], "systems": [ { "id": "d0050", "name": "IT Provisioning Portal" } ] } ] } ] }
- Response properties
- Properties that have no value are not present.
- spaces
- An array that defines a
space. Each space can have a list ofprocesses. - processes
- An array that defines a
process. Eachprocesscan have a list ofmilestonesand searched for properties. - decisions
- An array that defines a
decision. Eachdecisioncan have a list ofsub-decisionsand searched for properties. - sub-decisions
- An array that defines a
sub-decision. Eachsub-decisioncan have searched for properties. - milestones
- An array that defines a
milestone. Each milestone can have a list ofactivitiesand searched for properties. - activities
- An array that defines an
activity. Eachactivitycan have a list of searched for properties. - businessOwners
- An array that contains the IDs of any business owners who are linked to the
activityordecision. Each entry is aname,idpair. - customers
- An array that contains the IDs of any customers who are associated with the
activity. Each entry is aname,idpair. - experts
- An array that contains the IDs of any experts who are linked to the
activityordecision. Each entry is aname,idpair. - inputs
- An array that contains the IDs of any inputs that are linked to the
activityordecision. Each entry is aname,idpair. - name
- The name of the item.
- id
- The ID of the item. This ID is not present for the number properties.
- outputs
- An array that contains the IDs of any outputs that are linked to the
activityordecision. Each entry is aname,idpair. - participants
- An array that contains the IDs of any participants who are linked to the
activity. Each entry is aname,idpair. - externalParticipant
- An array that contains the ID of an external participant who are linked to a message event
activity. There is only one entry, and it contains aname,idpair. - problems
- An array that contains the IDs of any problems that are linked to the
activity. Each entry is aname,idpair. - suppliers
- An array that contains the IDs of any suppliers who are associated with the
activity. Each entry is aname,idpair. - systems
- An array that contains the IDs of any systems that are associated with the
activity. Each entry is aname,idpair. - linkedActivityId
- The activity ID of the other activity that the
activityis linked to. If this ID isn't present, then theactivityis not linked to an activity. The IDs of all processes are returned in version20191214in thelinkedItemsproperty. - linkedItems
- An array that contains the values of
linkedActivityIdandlinkedProcessIdfor a message event activity. This array is returned only in version20191214. - linkedProcessId
- If the linkedActivityId is present, the linkedProcessId property is the ID of the process that the linked activity
belongs to. Otherwise, this property is the process ID of the process that the
activitylinks to. This ID is returned in versions20111217(deprecated) and20120130(deprecated) of the API. If this ID isn't present, then theactivitydoesn't link to a process. If the activity is linked to more than one process, only the ID of the first process is returned. The IDs of all processes are returned in version20191214in thelinkedItemsproperty. - linkedProcessIds
- A list of process IDs for the processes that the activity links to. This list is returned in
versions
20150930(deprecated) and20191214of the API. If this list isn't present, then the activity doesn't link to any processes. - kpis
- An array that contains the IDs of any key performance indicators that are linked to the
decision. Each entry is aname,idpair. - business_motivation
- The value of the business motivation property that is linked to the
decision. The entry has anametag. - decision_how_often_made
- The value of how often the decision is made that is linked to the
decision. The entry has anametag. - decision_volume
- The value of the decision volume property that is linked to the
decision. The entry has anametag. - decision_how_often_updated
- The value of how often the decision is updated that is linked to the
decision. The entry has anametag. - decision_frequency
- The value of the decision frequency property that is linked to the
decision. The entry has anametag. - decision_how_much_time
- The value of how much time the decision takes that is linked to the
decision. The entry has anametag. - decision_latency
- The value of the decision latency property that is linked to the
decision. The entry has anametag. - sources
- The value of the sources property that is linked to the
decision. The entry has anametag.
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
400 There was an error processing the request. Required parameters were missing or contained invalid values.
401 The user isn't authorized to make the request.
- Each