Get decision traces
Returns a collection of decision traces. The traces can either be returned in either text/tab-separated-values or application/vnd.sas.collection+json format. The former would be the same format used for adding a decision trace. In the latter format, the traces without the actual trace texts are returned as items in a collection.
There are two types of traces: one is at the decision step boundary and the other is at the variable assignment. Each GET only obtains the type of traces specified. The scope query parameter is used to specify the type of traces.
The order of the columns for query parameter scope=step in tab-separated-values format are: traceid, seqno, tracetimestamp, objecturi, processornote, text. The version is 1 implicitly. Always use the column heading to help you locate a specific column. The order of the column and the number of columns are not fixed.
The order of the columns for query parameter scope=assignment in tab-separated-values format are: traceid, seqno, tracetimestamp, objecturi, processornote, version, scope, and text. The current version is 2. However, always use the column heading to help you locate a specific column. The order of the column and the number of columns might change in a future version.
1{2 "links": [3 {4 "method": "GET",5 "rel": "collection",6 "href": "/subjectContacts/traces",7 "uri": "/subjectContacts/traces",8 "type": "application/vnd.sas.collection",9 "itemType": "application/vnd.sas.decision.trace"10 },11 {12 "method": "GET",13 "rel": "self",14 "href": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=0&limit=10",15 "uri": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=0&limit=10",16 "type": "application/vnd.sas.collection",17 "itemType": "application/vnd.sas.decision.trace"18 },19 {20 "method": "GET",21 "rel": "up",22 "href": "/subjectContacts/",23 "uri": "/subjectContacts/",24 "type": "application/vnd.sas.api"25 },26 {27 "method": "GET",28 "rel": "next",29 "href": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=10&limit=10",30 "uri": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=10&limit=10",31 "type": "application/vnd.sas.collection",32 "itemType": "application/vnd.sas.decision.trace"33 },34 {35 "method": "GET",36 "rel": "last",37 "href": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=210&limit=10",38 "uri": "/subjectContacts/traces?filter=eq(sequenceNumber,1)&sortBy=traceTimeStamp:ascending,sequenceNumber:ascending:secondary&start=210&limit=10",39 "type": "application/vnd.sas.collection",40 "itemType": "application/vnd.sas.decision.trace"41 },42 {43 "method": "POST",44 "rel": "create",45 "href": "/subjectContacts/traces",46 "uri": "/subjectContacts/traces",47 "type": "text/tab-separated-values",48 "responseType": "multipart/mixed"49 }50 ],51 "name": "items",52 "start": 0,53 "count": 1,54 "items": [55 {56 "traceId": "3d4120b3-1fe7-4fce-b333-0ae1b93aa03c",57 "traceTimeStamp": "2020-08-07T18:02:23Z",58 "processorNote": "",59 "objectUri": "/decisions/flows/835b0890-bca3-42f1-8a50-9dcce2c4a377/revisions/6f5c045a-94a6-4f9b-9adc-cc1dde33558",60 "links": [61 {62 "method": "GET",63 "rel": "self",64 "href": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')",65 "uri": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')",66 "type": "application/vnd.sas.decision.trace"67 },68 {69 "method": "GET",70 "rel": "completeWithTraceText",71 "href": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')",72 "uri": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')",73 "type": "text/tab-separated-values"74 },75 {76 "method": "POST",77 "rel": "update",78 "href": "/subjectContacts/traces",79 "uri": "/subjectContacts/traces",80 "type": "text/tab-separated-values",81 "responseType": "multipart/mixed"82 },83 {84 "method": "DELETE",85 "rel": "delete",86 "href": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')",87 "uri": "/subjectContacts/traces?filter=eq(traceId,'3d4120b3-1fe7-4fce-b333-0ae1b93aa03c')"88 }89 ]90 }91 ]92}
| Name | Type | Required | Description |
|---|---|---|---|
scope | string | false | The type of traces. Allowed values: assignmentstep Default: step |
filter | string<filter-criteria> | false | The filter criteria for the returned traces. The fields that can be used are traceId, traceTimeStamp and processorNote. |
limit | integer | false | The maximum number of items to return on this page. The actual number of returned items might be less if there are no more items in the collection. The default is 10 for the application/vnd.sas.collection+json format. For the tab-separated-values format the default is 1 because the trace text is included in the output. Trace text can be very long. There is much higher potential of exhausting the service's memory when retrieving a lot of trace texts at once. |
sortBy | string<sort-criteria> | false | The sorting criteria for the returned traces. |
start | integer | false | The starting index of the first item on a page. The index is 0-based. The default index is 0. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. | Headers | Schema |
| 400 | Bad Request | The request was invalid. | Headers | Schema |