--- updatedAt: 2026-04-24T17:53:54.000Z agentTools: projectIndex: https://developer.corrigo.com/llms.txt --- # GET (Retrieve) Learn how to retrieve the current state of any Entity Use the GET method along with the Entity Class Name and instance Id, and the API will return the current state of that Entity. Use the properties Query String parameter to control the data elements that are populated in the result set. GET **\{Host Name}**/api/v1/base/**\{Entity Name}**/**\{ID of Entity}**?properties=**\{property1,property2}** where **\{Host Name}** is derived from [GetCompanyWsdkUrlCommand.Url](https://corrigo-enterprise-2022.readme.io/reference/cmd#getcompanywsdkurlcommand), and\ **\{EntityType}** is a class listed in [Entities ](https://corrigo-enterprise-2022.readme.io/reference/entities-and-commands#entities)namespace and,\ **\{ID of Entity}** is a valid internal id value, and\ **\{property1,property2}** is a comma-separated list of child elements as defined in the class library for the \{Entity Name} Below are examples for the most commonly used Entities in Corrigo Enterprise. ## Contact Examples A Contact entity represents a registered work requestor and potential user of the Corrigo Customer Portal. Execution of GET operation shall result a single entity in the Response. ```http (HTTP) Basic GET https://am-ent-f2b.corrigo.com/api/v1/base/Contact/2 HTTP/1.1 Accept-Encoding: gzip,deflate CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmMyZjMiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDA2IERlYyAyMDIxIDE4OjMxOjQ4IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAwNiBEZWMgMjAyMSAxODo1MTo0OCBHTVQifX19<---->wyg9IYpX6ORqfRLJMSYC4T2JZ81xmWalmdpaLst-ZigVN-yIpmHdM43fSZVCuIUlq-4pjJ23r8E--UmRywdT7eBivU7loXVRGNyijZPDuQM3Da_WTJnX1kA5v9k9s2Ls9S-SBzXJLajMHsITu5YhK-XlTwaTUX9lwe3-EoFtcJ1cdahKjgBksYzXIcpLEJfMyNlZXou4ZhrgKkPoPKlaqsIWIhj63T4bqFHN5YBqRsYeEdzFZIF70AD3CnyjGIRuoufH7LAgYwynv7HESaeWO7cCCbtoRPmOmnjiCS3wV4aiSmeATD-b4bXlsQUoroNg_c1feItG2iCSHfQ884sQYA Content-Length: 0 Connection: Keep-Alive User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1) ``` ```json (JSON) Response { "Data" : { "DisplayAs" : "Velz Antonio", "FirstName" : "Velz", "LastName" : "Antonio", "TypeId" : "Primary", "CustomerId" : 1, "CanViewAnyRequest" : true, "CanCreateRequest" : false, "PriorityThreshold" : 255, "CustomFields" : [ ], "ContactAddresses" : [ ], "GroupsBridge" : [ ], "Username" : "velzond.antonio@ap.jll.com", "Number" : "", "MustResetPassword" : false, "NoAlertEmails" : false, "Comment" : "", "UnlimitedRequest" : true, "UnlimitedAuthorization" : false, "SupervisorId" : 0, "LanguageId" : 1033, "CustomerNoteAccessId" : "View", "NoPwdExpirationAlert" : false, "Currencies" : [ ], "IsRemoved" : false, "ConcurrencyId" : 16, "Id" : 1, "PerformDeletion" : false, "IsNew" : false } } ``` > 👍 How to populate Child Collections in GET response > > Notice how the JSON response in example above has several child collections that are empty like **ContactAddresses\[]**? That's because in the above **GET** request, the **properties** parameter was empty. See below for a more advanced version of the same operation, where the **properties** parameter includes an expression **ContactAddresses.**\* which results in the population of elements in that child collection. ```http (HTTP) Populating child collections GET https://am-ent-f2b.corrigo.com/api/v1/base/Contact/1?properties=ContactAddresses.* HTTP/1.1 Accept-Encoding: gzip,deflate CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmMyZjMiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDA2IERlYyAyMDIxIDE4OjMxOjQ4IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAwNiBEZWMgMjAyMSAxODo1MTo0OCBHTVQifX19<---->wyg9IYpX6ORqfRLJMSYC4T2JZ81xmWalmdpaLst-ZigVN-yIpmHdM43fSZVCuIUlq-4pjJ23r8E--UmRywdT7eBivU7loXVRGNyijZPDuQM3Da_WTJnX1kA5v9k9s2Ls9S-SBzXJLajMHsITu5YhK-XlTwaTUX9lwe3-EoFtcJ1cdahKjgBksYzXIcpLEJfMyNlZXou4ZhrgKkPoPKlaqsIWIhj63T4bqFHN5YBqRsYeEdzFZIF70AD3CnyjGIRuoufH7LAgYwynv7HESaeWO7cCCbtoRPmOmnjiCS3wV4aiSmeATD-b4bXlsQUoroNg_c1feItG2iCSHfQ884sQYA Content-Length: 0 Connection: Keep-Alive User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1) ``` ```json (JSON) Response { "Data" : { "DisplayAs" : "Velz Antonio", "FirstName" : "Velz", "LastName" : "Antonio", "TypeId" : "Primary", "CustomerId" : 1, "CanViewAnyRequest" : true, "CanCreateRequest" : false, "PriorityThreshold" : 255, "CustomFields" : [ ], "ContactAddresses" : [ { "ActorTypeId" : "LeaseUser", "ActorId" : 1, "AddrTypeId" : "PrimEmail", "Address" : "c909@test.corrigo.com", "IsAlert" : false, "IsReport" : false, "ConcurrencyId" : 1, "Id" : 909, "PerformDeletion" : false, "IsNew" : false } ], "GroupsBridge" : [ ], "Username" : "velzond.antonio@ap.jll.com", "Number" : "", "MustResetPassword" : false, "NoAlertEmails" : false, "Comment" : "", "UnlimitedRequest" : true, "UnlimitedAuthorization" : false, "SupervisorId" : 0, "LanguageId" : 1033, "CustomerNoteAccessId" : "View", "NoPwdExpirationAlert" : false, "Currencies" : [ ], "IsRemoved" : false, "ConcurrencyId" : 16, "Id" : 1, "PerformDeletion" : false, "IsNew" : false } } ``` ## WorkOrder Examples This entity, as the core of the system, has the most verbose default structure. Basic **GET** operation without explicit **properties** expression will return a large structure of related entities - **WorkOrderCost** entity, **Workzone** entity, **RequestorContact** entity and many other relationships. ```http (HTTP) Basic GET https://am-ent-f2b.corrigo.com/api/v1/base/WorkOrder/500 HTTP/1.1 CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA1OjI5OjU2IEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNTo0OTo1NiBHTVQifX19<---->epVI8vnlSbMv3coF2Lfxpe2hrS0yVBiXz4GLw7C8zfLZ9JUUn53v-YbTWpegzbZhMWC6vFTBnKjojF4wkGaVIhbYcoeW6u0JIclHqgqtRt_zwaMBeicDFas7ZyIFjZmsS86MJ8Shma5RU37L5wF-98iaSRs0CHCR0K0WqosbDVFa37HsWDVOQKikgccg_7YucpGtYKorlc2K5T-Bo2JsetBzfJIF0TLrzkuLeZ7PcJIznSW0-Fqcd12gp-srMP5xffHs1h9f42GdmJ_jH18G6HZ_kgdszYvJxeSe9XXpFDy4QmYCIU2ezuy07aU71-jpW7KgHzU3ZXzIQt2asc7QIg ``` ```json (JSON) Response body { "Data": { "Number": "54250009", "TypeCategory": "Request", "WorkOrderCost": { "Id": 500, "CurrencyTypeId": "Unknown", "BillToType": "None", "CostsTotal": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "ApStateId": "None", "ApStatusId": 1, "JobCode": "", "AuthorizationCode": "", "CheckNumber": "", "PaymentAmount": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "PaymentNotes": "", "GlAccount": "", "Number": "", "VendorInvoiceTotal": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "IsPreBilled": false, "ExpensesTotal": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "BillingRule": "Unknown", "TaxStatus": "Unknown", "CustomerNte": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "Items": [], "ServiceFeesTotal": { "CurrencyTypeId": "Unknown", "Value": 0.0 }, "CostStatusId": 1, "CostState": "Pending", "ExternalId": "", "ConcurrencyId": 0, "PerformDeletion": false, "IsNew": false }, "Priority": { "IsEmergency": false, "AcknowledgeInMinutes": 0, "RespondInMinutes": 0, "DueInMinutes": 0, "Id": 2, "PerformDeletion": false, "IsNew": false }, "StatusId": "Completed", "RequestorContact": { "DisplayAs": "", "FirstName": "", "LastName": "", "TypeId": "Unknown", "CustomerId": 0, "CanViewAnyRequest": false, "CanCreateRequest": false, "PriorityThreshold": 0, "CustomFields": [], "ContactAddresses": [], "GroupsBridge": [], "MustResetPassword": false, "NoAlertEmails": false, "UnlimitedRequest": false, "UnlimitedAuthorization": false, "SupervisorId": 0, "LanguageId": 0, "CustomerNoteAccessId": "Unknown", "NoPwdExpirationAlert": false, "Currencies": [], "IsRemoved": false, "ConcurrencyId": 0, "Id": 16, "PerformDeletion": false, "IsNew": false }, "Access": "NotApplicable", "MainAsset": { "Name": "", "ModelId": 0, "Orphan": false, "TypeId": "Unknown", "ParentId": 0, "RootId": 0, "IsTemplate": false, "Documents": [], "IsOffline": false, "IsLocked": false, "Attributes": [], "Id": 4079, "PerformDeletion": false, "IsNew": false }, "ShortLocation": "Store - 5425", "TaskRefinement": "Ice Machine:Not making ice:please need to fix not ice at ta store.", "WorkZone": { "DisplayAs": "", "TimeZone": 0, "LanguageId": 0, "WoNumberPrefix": "", "Entity": "", "SchedulingWindow": 0, "NoIncompleteProcedure": false, "AccessOptionsMask": 0, "Number": "", "AdvanceNotice": 0, "WoNumberDigits": 0, "RoundApptTimeTo": 0, "WorkPlanAutoCancel": false, "WorkPlanChildResolution": false, "WorkPlanAutoDependency": false, "CpThemeId": 0, "DefaultAccess": "Unknown", "AutoAssignEnabled": false, "BackupRoutingId": "Unassigned", "NoIncompleteItem": false, "UiShowProvidersFirst": false, "CurrencyTypeId": "Unknown", "IsOffline": false, "ContactAddresses": [], "CustomFields": [], "Portfolios": [], "SlaValues": [], "Teams": [], "BizHours": [], "EscalationRules": [], "SpecDispatchRules": [], "OnCallRules": [], "Responsibilities": [], "UseBizHours": false, "UseHolidays": false, "UseOnCall": false, "UseEscalation": false, "DefaultBillToLogic": 0, "TurnKickOffAuto": false, "TurnKickOffLagDays": 0, "TurnKickOffOnDays": 0, "EarliestSlot": 0, "LatestSlot": 0, "SlotsCount": 0, "IsPrecalculatedSchedule": false, "AllowTimePreference": false, "TurnTemplateId": 0, "IsmSpecGroupId": 0, "IsmUrl": "", "ExcludeNonCompliantProviders": "InheritGlobalSettings", "IsNteAuto": true, "IsRemoved": false, "ConcurrencyId": 0, "Id": 14, "PerformDeletion": false, "IsNew": false }, "Employee": { "FirstName": "", "LastName": "", "DisplayAs": "", "AccessToAllWorkZones": false, "LanguageId": 0, "ActorTypeId": "Unknown", "Username": "", "DtPwdChange": "0001-01-01T00:00:00", "Instructions": "", "WonMemberId": 0, "WonLocationId": 0, "WonServiceRadius": 0, "IsElectronicPayment": false, "ProviderStatusId": "NA", "LabelId": 0, "FreeTextAllowed": false, "RadiusUnit": "Unknown", "Password": "", "Number": "", "JobTitle": "", "FederalId": "", "ExternalId": "", "ForcePasswordReset": false, "TaxWarnOnly": false, "PriceLists": [], "CustomFields": [], "BillAtZero": false, "IsSupplier": false, "ProviderTypeId": "Regular", "ContactAddresses": [], "Teams": [], "WorkZones": [], "Portfolios": [], "CustomerGroups": [], "Specialties": [], "PayRates": [], "StockLocations": [], "Services": [], "AlertSubscriptions": [], "TaxExempt": false, "LimitAssignmentByPortfolioId": 0, "IsRemoved": false, "ConcurrencyId": 0, "Id": 6, "PerformDeletion": false, "IsNew": false }, "Duration": 0, "VendorNte": { "CurrencyTypeId": "USD", "Value": 0.0000 }, "Specialty": { "DisplayAs": "", "WONServiceId": 0, "Instructions": "", "Currencies": [], "IsNteAuto": true, "IsRemoved": false, "ConcurrencyId": 0, "Id": 10016, "PerformDeletion": false, "IsNew": false }, "PoNumber": "", "SubType": { "TypeId": "Unknown", "IsDefSR": false, "IsDefBasic": false, "IsRemoved": false, "ConcurrencyId": 0, "Id": 259, "PerformDeletion": false, "IsNew": false }, "RepairCode": { "DisplayAs": "", "ParentId": 0, "Codes": [], "IsRemoved": false, "ConcurrencyId": 0, "Id": 251, "PerformDeletion": false, "IsNew": false }, "Customer": { "DisplayAs": "", "Name": "", "Dba": "", "Instructions": "", "TenantCode": "", "TaxExempt": false, "Spaces": [], "Contacts": [], "CustomFields": [], "Notes": [], "Addresses": [], "GroupsBridge": [], "ApprovalScopes": [], "IsRemoved": false, "ConcurrencyId": 0, "Id": 16, "PerformDeletion": false, "IsNew": false }, "ContactName": "Store Manager or General Manager ", "WonId": 0, "IsWarranty": false, "FlagId": 0, "TimeZone": 4, "CurrencyTypeId": "USD", "LastActionDate": "2006-09-25T09:16:44", "DtCreated": "2006-08-18T07:38:00", "DtDue": "2006-08-21T08:00:00", "LastActionDateUtc": "2006-09-25T16:16:44", "CreatedDateUtc": "2006-08-18T14:38:00", "DueDateUtc": "2006-08-21T15:00:00", "LastAction": { "Id": 500, "WorkOrderId": 0, "BillStatus": "NotBilled", "PerformDeletion": false, "IsNew": false }, "Items": [], "EquipmentWorkedOn": [], "Notes": [], "Assignments": [], "Procedures": [], "Documents": [], "CustomFields": [], "Verifications": [], "CheckInOuts": [], "ActionLogRecords": [], "InductionAndSafetyStatusID": "NotApplicable", "Flags": [], "ConcurrencyId": 7, "Id": 500, "PerformDeletion": false, "IsNew": false } } ``` To retrieve a more efficient dataset, use the **properties** parameter to restrict to only those collections needed. ```http (HTTP) Optimized GET https://am-ent-f2b.corrigo.com/api/v1/base/WorkOrder/500?properties=Priority.*,SubType.*,LastAction.* HTTP/1.1 CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmI5ZmUiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJXZWQsIDI5IERlYyAyMDIxIDA1OjI5OjU2IEdNVCIsIi5leHBpcmVzIjoiV2VkLCAyOSBEZWMgMjAyMSAwNTo0OTo1NiBHTVQifX19<---->epVI8vnlSbMv3coF2Lfxpe2hrS0yVBiXz4GLw7C8zfLZ9JUUn53v-YbTWpegzbZhMWC6vFTBnKjojF4wkGaVIhbYcoeW6u0JIclHqgqtRt_zwaMBeicDFas7ZyIFjZmsS86MJ8Shma5RU37L5wF-98iaSRs0CHCR0K0WqosbDVFa37HsWDVOQKikgccg_7YucpGtYKorlc2K5T-Bo2JsetBzfJIF0TLrzkuLeZ7PcJIznSW0-Fqcd12gp-srMP5xffHs1h9f42GdmJ_jH18G6HZ_kgdszYvJxeSe9XXpFDy4QmYCIU2ezuy07aU71-jpW7KgHzU3ZXzIQt2asc7QIg ``` ```json (JSON) Response { "Data": { "Number": "54250009", "TypeCategory": "Request", "Priority": { "IsEmergency": false, "AcknowledgeInMinutes": 0, "RespondInMinutes": 0, "DueInMinutes": 0, "Id": 2, "PerformDeletion": false, "IsNew": false }, "StatusId": "Completed", "Access": "NotApplicable", "ShortLocation": "Store - 5425", "TaskRefinement": "Ice Machine:Not making ice:please need to fix not ice at ta store.", "Duration": 0, "PoNumber": "", "SubType": { "TypeId": "Unknown", "IsDefSR": false, "IsDefBasic": false, "IsRemoved": false, "ConcurrencyId": 0, "Id": 259, "PerformDeletion": false, "IsNew": false }, "ContactName": "Store Manager or General Manager ", "WonId": 0, "IsWarranty": false, "FlagId": 0, "TimeZone": 4, "CurrencyTypeId": "USD", "LastActionDate": "2006-09-25T09:16:44", "DtCreated": "2006-08-18T07:38:00", "DtDue": "2006-08-21T08:00:00", "LastActionDateUtc": "2006-09-25T16:16:44", "CreatedDateUtc": "2006-08-18T14:38:00", "DueDateUtc": "2006-08-21T15:00:00", "LastAction": { "Id": 500, "WorkOrderId": 0, "BillStatus": "NotBilled", "PerformDeletion": false, "IsNew": false }, "Items": [], "EquipmentWorkedOn": [], "Notes": [], "Assignments": [], "Procedures": [], "Documents": [], "CustomFields": [], "Verifications": [], "CheckInOuts": [], "ActionLogRecords": [], "InductionAndSafetyStatusID": "NotApplicable", "Flags": [], "ConcurrencyId": 7, "Id": 500, "PerformDeletion": false, "IsNew": false } } ``` ## Workzone Examples The Workzone entity is the root of the Asset/Task hierarchy, in addition to where most other entities relationships are stored such as Portfolios. Teams, BizHours, EscalationRules, Responsibilities, etc. ```http (HTTP) Basic GET https://am-ent-f2b.corrigo.com/api/v1/base/Workzone/100 HTTP/1.1 CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDEyOjU0OjQ0IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxMzoxNDo0NCBHTVQifX19<---->eXPiHxL7IpgtHSEXRi9gtEsQQyNbMMgFOOkk44JF-zZGEVlGaE1mdSGGplW-TgcVOd7wZVpa-vDGR4Rxdz4giGpcCeSJ3gJCRKhUvap7U6GJgt7FPdDpYwIYFV1fCEQk0yvstqw-3_uVbamElt9ebF0lX2vvaR66y5Xci5V93G15CSlof6eSser2ciAjXjjx2yDcpGnqRl8Iec51k9v_rdDszvAkj8ZlZevEouDXrQJud-9w8sVyHE2vaPzBYg2ybo81VUy1hRkaX0aSB3sgFKo_3zlBDi--lydOHPHnYPaiRZ_KqfP5XBSN-9Fd-IP10C0eZHytj8v1vfEdZLNwdQ ``` ```json { "Data": { "DisplayAs": "z5634 - 9185 CENTRAL AVENUE", "Asset": { "Name": "", "ModelId": 0, "Orphan": false, "TypeId": "Unknown", "ParentId": 0, "RootId": 0, "IsTemplate": false, "Documents": [], "IsOffline": false, "IsLocked": false, "Attributes": [], "Id": 17066, "PerformDeletion": false, "IsNew": false }, "TimeZone": 4, "LanguageId": 1033, "WoNumberPrefix": "5634", "Entity": "", "SchedulingWindow": 15, "NoIncompleteProcedure": false, "AccessOptionsMask": 8, "Number": "x-5634", "AdvanceNotice": 0, "WoNumberDigits": 4, "RoundApptTimeTo": 60, "WorkPlanAutoCancel": false, "WorkPlanChildResolution": false, "WorkPlanAutoDependency": false, "CpThemeId": 0, "DefaultAccess": "NotApplicable", "AutoAssignEnabled": false, "BackupRoutingId": "Unassigned", "NoIncompleteItem": false, "UiShowProvidersFirst": true, "CurrencyTypeId": "USD", "IsOffline": false, "ContactAddresses": [], "CustomFields": [], "Portfolios": [], "SlaValues": [], "Teams": [], "BizHours": [], "EscalationRules": [], "SpecDispatchRules": [], "OnCallRules": [], "Responsibilities": [], "UseBizHours": true, "UseHolidays": true, "UseOnCall": true, "UseEscalation": true, "DefaultBillToLogic": 1, "TurnKickOffAuto": false, "TurnKickOffLagDays": 6, "TurnKickOffOnDays": 127, "EarliestSlot": 1, "LatestSlot": 7, "SlotsCount": 3, "IsPrecalculatedSchedule": false, "AllowTimePreference": false, "TurnTemplateId": 0, "IsmSpecGroupId": 0, "IsmUrl": "", "ExcludeNonCompliantProviders": "InheritGlobalSettings", "IsNteAuto": true, "IsRemoved": false, "ConcurrencyId": 3, "Id": 100, "PerformDeletion": false, "IsNew": false } } ``` Workzones contain many child collections which demonstrates the influence this entity can have on automated operations within Corrigo Enterprise. ```http (HTTP) Populating child collections GET https://am-ent-f2b.corrigo.com/api/v1/base/Workzone/100?properties=Portfolios.*,OnCallRules.* HTTP/1.1 CompanyName: Your Company Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDEyOjU0OjQ0IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxMzoxNDo0NCBHTVQifX19<---->eXPiHxL7IpgtHSEXRi9gtEsQQyNbMMgFOOkk44JF-zZGEVlGaE1mdSGGplW-TgcVOd7wZVpa-vDGR4Rxdz4giGpcCeSJ3gJCRKhUvap7U6GJgt7FPdDpYwIYFV1fCEQk0yvstqw-3_uVbamElt9ebF0lX2vvaR66y5Xci5V93G15CSlof6eSser2ciAjXjjx2yDcpGnqRl8Iec51k9v_rdDszvAkj8ZlZevEouDXrQJud-9w8sVyHE2vaPzBYg2ybo81VUy1hRkaX0aSB3sgFKo_3zlBDi--lydOHPHnYPaiRZ_KqfP5XBSN-9Fd-IP10C0eZHytj8v1vfEdZLNwdQ ``` ```json (JSON) Response <> ``` ## Applying to other EntityTypes The base **GET** operation covers the entire **CorrigoService.Entities** namespace. Use the reference library to understand the element names and child collections for the **EntityType** for your GET operation. Use this understanding to build your **properties** expression so that your retrieval is optimized for your particular application. [Check here for CorrigoService Class Library](https://securecontent.corrigo.com/docs/HelpCE921) {1247}