Chilkat Online Tools

PureBasic / Creatio API / $filter parameter (eq operator) with Id

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"$filter","Collection6/Field6 eq Id")

    CkHttp::ckSetRequestHeader(http,"ForceUseSession","true")
    CkHttp::ckSetRequestHeader(http,"BPMCSRF","{{BPMCSRF}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://myserver.com/0/odata/Collection3",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "@odata.context": "https://myserver.com/0/odata/$metadata#Contact",
    ;   "value": [
    ;     {
    ;       "Id": "7aec3929-5d18-4086-ad7c-0fd9315e637a",
    ;       "Name": "Lynn A. Collins",
    ;       "OwnerId": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "CreatedOn": "2019-12-01T13:52:24Z",
    ;       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    ;       "ModifiedOn": "2016-09-05T10:08:22Z",
    ;       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    ;       "ProcessListeners": 0,
    ;       "Dear": "",
    ;       "SalutationTypeId": "f4b32ee6-f36b-1410-aa84-00155d043204",
    ;       "GenderId": "00000000-0000-0000-0000-000000000000",
    ;       "AccountId": "00000000-0000-0000-0000-000000000000",
    ;       "DecisionRoleId": "00000000-0000-0000-0000-000000000000",
    ;       "TypeId": "806732ee-f36b-1410-a883-16d83cab0980",
    ;       "JobId": "00000000-0000-0000-0000-000000000000",
    ;       "JobTitle": "",
    ;       "DepartmentId": "00000000-0000-0000-0000-000000000000",
    ;       "BirthDate": "1991-03-20T00:00:00Z",
    ;       "Phone": "",
    ;       "MobilePhone": "",
    ;       "HomePhone": "",
    ;       "Skype": "",
    ;       "Email": "",
    ;       "AddressTypeId": "00000000-0000-0000-0000-000000000000",
    ;       "Address": "",
    ;       "CityId": "00000000-0000-0000-0000-000000000000",
    ;       "RegionId": "00000000-0000-0000-0000-000000000000",
    ;       "Zip": "",
    ;       "CountryId": "00000000-0000-0000-0000-000000000000",
    ;       "DoNotUseEmail": true,
    ;       "DoNotUseCall": true,
    ;       "DoNotUseFax": true,
    ;       "DoNotUseSms": true,
    ;       "DoNotUseMail": true,
    ;       "Notes": "",
    ;       "Facebook": "",
    ;       "LinkedIn": "",
    ;       "Twitter": "",
    ;       "FacebookId": "",
    ;       "LinkedInId": "",
    ;       "TwitterId": "",
    ;       "ContactPhoto@odata.mediaEditLink": "Contact(7aec3929-5d18-4086-ad7c-0fd9315e637a)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaReadLink": "Contact(7aec3929-5d18-4086-ad7c-0fd9315e637a)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaContentType": "application/octet-stream",
    ;       "TwitterAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "FacebookAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "LinkedInAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "PhotoId": "00000000-0000-0000-0000-000000000000",
    ;       "GPSN": "",
    ;       "GPSE": "",
    ;       "Surname": "",
    ;       "GivenName": "",
    ;       "MiddleName": "",
    ;       "Confirmed": false,
    ;       "IsNonActualEmail": false,
    ;       "Completeness": 15,
    ;       "LanguageId": "00000000-0000-0000-0000-000000000000",
    ;       "Age": 29
    ;     },
    ;     {
    ;       "Id": "bb843dd1-3802-424c-9c02-489702de9f1d",
    ;       "Name": "Administrator",
    ;       "OwnerId": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "CreatedOn": "2020-07-14T02:14:20.806177Z",
    ;       "CreatedById": "00000000-0000-0000-0000-000000000000",
    ;       "ModifiedOn": "2020-07-14T02:14:20.806177Z",
    ;       "ModifiedById": "00000000-0000-0000-0000-000000000000",
    ;       "ProcessListeners": 0,
    ;       "Dear": "",
    ;       "SalutationTypeId": "00000000-0000-0000-0000-000000000000",
    ;       "GenderId": "00000000-0000-0000-0000-000000000000",
    ;       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    ;       "DecisionRoleId": "00000000-0000-0000-0000-000000000000",
    ;       "TypeId": "60733efc-f36b-1410-a883-16d83cab0980",
    ;       "JobId": "00000000-0000-0000-0000-000000000000",
    ;       "JobTitle": "",
    ;       "DepartmentId": "00000000-0000-0000-0000-000000000000",
    ;       "BirthDate": "0001-01-01T00:00:00Z",
    ;       "Phone": "",
    ;       "MobilePhone": "",
    ;       "HomePhone": "",
    ;       "Skype": "",
    ;       "Email": "",
    ;       "AddressTypeId": "00000000-0000-0000-0000-000000000000",
    ;       "Address": "",
    ;       "CityId": "00000000-0000-0000-0000-000000000000",
    ;       "RegionId": "00000000-0000-0000-0000-000000000000",
    ;       "Zip": "",
    ;       "CountryId": "00000000-0000-0000-0000-000000000000",
    ;       "DoNotUseEmail": false,
    ;       "DoNotUseCall": false,
    ;       "DoNotUseFax": false,
    ;       "DoNotUseSms": false,
    ;       "DoNotUseMail": false,
    ;       "Notes": "",
    ;       "Facebook": "",
    ;       "LinkedIn": "",
    ;       "Twitter": "",
    ;       "FacebookId": "",
    ;       "LinkedInId": "",
    ;       "TwitterId": "",
    ;       "ContactPhoto@odata.mediaEditLink": "Contact(bb843dd1-3802-424c-9c02-489702de9f1d)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaReadLink": "Contact(bb843dd1-3802-424c-9c02-489702de9f1d)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaContentType": "application/octet-stream",
    ;       "TwitterAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "FacebookAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "LinkedInAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "PhotoId": "00000000-0000-0000-0000-000000000000",
    ;       "GPSN": "",
    ;       "GPSE": "",
    ;       "Surname": "",
    ;       "GivenName": "",
    ;       "MiddleName": "",
    ;       "Confirmed": false,
    ;       "IsNonActualEmail": false,
    ;       "Completeness": 0,
    ;       "LanguageId": "00000000-0000-0000-0000-000000000000",
    ;       "Age": 0
    ;     },
    ;     {
    ;       "Id": "c4ed336c-3e9b-40fe-8b82-5632476472b4",
    ;       "Name": "Andrew Baker (sample)",
    ;       "OwnerId": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "CreatedOn": "2018-06-04T12:13:18Z",
    ;       "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "ModifiedOn": "2016-09-15T14:27:21Z",
    ;       "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "ProcessListeners": 0,
    ;       "Dear": "",
    ;       "SalutationTypeId": "7426ffb3-56e6-df11-971b-001d60e938c6",
    ;       "GenderId": "eeac42ee-65b6-df11-831a-001d60e938c6",
    ;       "AccountId": "405947d0-2ffb-4ded-8675-0475f19f5a81",
    ;       "DecisionRoleId": "f71ee81d-0cac-4e41-b7dc-9d4bd2e08491",
    ;       "TypeId": "00783ef6-f36b-1410-a883-16d83cab0980",
    ;       "JobId": "cb49a603-57e6-df11-971b-001d60e938c6",
    ;       "JobTitle": "Specialist",
    ;       "DepartmentId": "2076c4b6-7fe6-df11-971b-001d60e938c6",
    ;       "BirthDate": "1986-06-05T00:00:00Z",
    ;       "Phone": "+1 617 440 2031",
    ;       "MobilePhone": "+1 617 221 5187",
    ;       "HomePhone": "",
    ;       "Skype": "",
    ;       "Email": "a.baker@ac.com",
    ;       "AddressTypeId": "4f8b2d67-71d0-45fb-897e-cd4a308a97c0",
    ;       "Address": "39 Columbia Street",
    ;       "CityId": "74144617-a288-4984-bcac-e78733277a61",
    ;       "RegionId": "658acfe7-09ae-4747-b1b3-541e2dfa1b9e",
    ;       "Zip": "02112",
    ;       "CountryId": "e0be1264-f36b-1410-fa98-00155d043204",
    ;       "DoNotUseEmail": false,
    ;       "DoNotUseCall": false,
    ;       "DoNotUseFax": false,
    ;       "DoNotUseSms": false,
    ;       "DoNotUseMail": false,
    ;       "Notes": "",
    ;       "Facebook": "",
    ;       "LinkedIn": "",
    ;       "Twitter": "",
    ;       "FacebookId": "",
    ;       "LinkedInId": "",
    ;       "TwitterId": "",
    ;       "ContactPhoto@odata.mediaEditLink": "Contact(c4ed336c-3e9b-40fe-8b82-5632476472b4)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaReadLink": "Contact(c4ed336c-3e9b-40fe-8b82-5632476472b4)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaContentType": "application/octet-stream",
    ;       "TwitterAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "FacebookAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "LinkedInAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "PhotoId": "00000000-0000-0000-0000-000000000000",
    ;       "GPSN": "",
    ;       "GPSE": "",
    ;       "Surname": "Baker",
    ;       "GivenName": "Andrew",
    ;       "MiddleName": "",
    ;       "Confirmed": true,
    ;       "IsNonActualEmail": false,
    ;       "Completeness": 30,
    ;       "LanguageId": "00000000-0000-0000-0000-000000000000",
    ;       "Age": 34
    ;     },
    ;     {
    ;       "Id": "9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7",
    ;       "Name": "Mary King",
    ;       "OwnerId": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
    ;       "CreatedOn": "2020-02-04T12:43:53Z",
    ;       "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    ;       "ModifiedOn": "2016-09-05T10:08:22Z",
    ;       "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
    ;       "ProcessListeners": 0,
    ;       "Dear": "King",
    ;       "SalutationTypeId": "f4b32ee6-f36b-1410-aa84-00155d043204",
    ;       "GenderId": "eeac42ee-65b6-df11-831a-001d60e938c6",
    ;       "AccountId": "e308b781-3c5b-4ecb-89ef-5c1ed4da488e",
    ;       "DecisionRoleId": "00000000-0000-0000-0000-000000000000",
    ;       "TypeId": "60733efc-f36b-1410-a883-16d83cab0980",
    ;       "JobId": "955472f0-56e6-df11-971b-001d60e938c6",
    ;       "JobTitle": "",
    ;       "DepartmentId": "2076c4b6-7fe6-df11-971b-001d60e938c6",
    ;       "BirthDate": "1981-09-05T00:00:00Z",
    ;       "Phone": "3020",
    ;       "MobilePhone": "",
    ;       "HomePhone": "",
    ;       "Skype": "",
    ;       "Email": "",
    ;       "AddressTypeId": "4f8b2d67-71d0-45fb-897e-cd4a308a97c0",
    ;       "Address": "73 Carson Road",
    ;       "CityId": "a1bf2e42-f36b-1410-0499-00155d043204",
    ;       "RegionId": "b1ae2e80-f36b-1410-3899-00155d043204",
    ;       "Zip": "",
    ;       "CountryId": "96ae123c-f46b-1410-f998-00155d043204",
    ;       "DoNotUseEmail": true,
    ;       "DoNotUseCall": true,
    ;       "DoNotUseFax": true,
    ;       "DoNotUseSms": true,
    ;       "DoNotUseMail": true,
    ;       "Notes": "",
    ;       "Facebook": "",
    ;       "LinkedIn": "",
    ;       "Twitter": "",
    ;       "FacebookId": "",
    ;       "LinkedInId": "",
    ;       "TwitterId": "",
    ;       "ContactPhoto@odata.mediaEditLink": "Contact(9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaReadLink": "Contact(9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7)/ContactPhoto",
    ;       "ContactPhoto@odata.mediaContentType": "application/octet-stream",
    ;       "TwitterAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "FacebookAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "LinkedInAFDAId": "00000000-0000-0000-0000-000000000000",
    ;       "PhotoId": "00000000-0000-0000-0000-000000000000",
    ;       "GPSN": "",
    ;       "GPSE": "",
    ;       "Surname": "",
    ;       "GivenName": "",
    ;       "MiddleName": "",
    ;       "Confirmed": false,
    ;       "IsNonActualEmail": false,
    ;       "Completeness": 30,
    ;       "LanguageId": "00000000-0000-0000-0000-000000000000",
    ;       "Age": 39
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Id.s
    Name.s
    OwnerId.s
    CreatedOn.s
    CreatedById.s
    ModifiedOn.s
    ModifiedById.s
    ProcessListeners.i
    Dear.s
    SalutationTypeId.s
    GenderId.s
    AccountId.s
    DecisionRoleId.s
    TypeId.s
    JobId.s
    JobTitle.s
    DepartmentId.s
    BirthDate.s
    Phone.s
    MobilePhone.s
    HomePhone.s
    Skype.s
    v_Email.s
    AddressTypeId.s
    Address.s
    CityId.s
    RegionId.s
    v_Zip.s
    CountryId.s
    DoNotUseEmail.i
    DoNotUseCall.i
    DoNotUseFax.i
    DoNotUseSms.i
    DoNotUseMail.i
    Notes.s
    Facebook.s
    LinkedIn.s
    Twitter.s
    FacebookId.s
    LinkedInId.s
    TwitterId.s
    ContactPhotoodata_mediaEditLink.s
    ContactPhotoodata_mediaReadLink.s
    ContactPhotoodata_mediaContentType.s
    TwitterAFDAId.s
    FacebookAFDAId.s
    LinkedInAFDAId.s
    PhotoId.s
    GPSN.s
    GPSE.s
    Surname.s
    GivenName.s
    MiddleName.s
    Confirmed.i
    IsNonActualEmail.i
    Completeness.i
    LanguageId.s
    Age.i

    odata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "@odata.context" + Chr(34))
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"value")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Id = CkJsonObject::ckStringOf(jResp,"value[i].Id")
        Name = CkJsonObject::ckStringOf(jResp,"value[i].Name")
        OwnerId = CkJsonObject::ckStringOf(jResp,"value[i].OwnerId")
        CreatedOn = CkJsonObject::ckStringOf(jResp,"value[i].CreatedOn")
        CreatedById = CkJsonObject::ckStringOf(jResp,"value[i].CreatedById")
        ModifiedOn = CkJsonObject::ckStringOf(jResp,"value[i].ModifiedOn")
        ModifiedById = CkJsonObject::ckStringOf(jResp,"value[i].ModifiedById")
        ProcessListeners = CkJsonObject::ckIntOf(jResp,"value[i].ProcessListeners")
        Dear = CkJsonObject::ckStringOf(jResp,"value[i].Dear")
        SalutationTypeId = CkJsonObject::ckStringOf(jResp,"value[i].SalutationTypeId")
        GenderId = CkJsonObject::ckStringOf(jResp,"value[i].GenderId")
        AccountId = CkJsonObject::ckStringOf(jResp,"value[i].AccountId")
        DecisionRoleId = CkJsonObject::ckStringOf(jResp,"value[i].DecisionRoleId")
        TypeId = CkJsonObject::ckStringOf(jResp,"value[i].TypeId")
        JobId = CkJsonObject::ckStringOf(jResp,"value[i].JobId")
        JobTitle = CkJsonObject::ckStringOf(jResp,"value[i].JobTitle")
        DepartmentId = CkJsonObject::ckStringOf(jResp,"value[i].DepartmentId")
        BirthDate = CkJsonObject::ckStringOf(jResp,"value[i].BirthDate")
        Phone = CkJsonObject::ckStringOf(jResp,"value[i].Phone")
        MobilePhone = CkJsonObject::ckStringOf(jResp,"value[i].MobilePhone")
        HomePhone = CkJsonObject::ckStringOf(jResp,"value[i].HomePhone")
        Skype = CkJsonObject::ckStringOf(jResp,"value[i].Skype")
        v_Email = CkJsonObject::ckStringOf(jResp,"value[i].Email")
        AddressTypeId = CkJsonObject::ckStringOf(jResp,"value[i].AddressTypeId")
        Address = CkJsonObject::ckStringOf(jResp,"value[i].Address")
        CityId = CkJsonObject::ckStringOf(jResp,"value[i].CityId")
        RegionId = CkJsonObject::ckStringOf(jResp,"value[i].RegionId")
        v_Zip = CkJsonObject::ckStringOf(jResp,"value[i].Zip")
        CountryId = CkJsonObject::ckStringOf(jResp,"value[i].CountryId")
        DoNotUseEmail = CkJsonObject::ckBoolOf(jResp,"value[i].DoNotUseEmail")
        DoNotUseCall = CkJsonObject::ckBoolOf(jResp,"value[i].DoNotUseCall")
        DoNotUseFax = CkJsonObject::ckBoolOf(jResp,"value[i].DoNotUseFax")
        DoNotUseSms = CkJsonObject::ckBoolOf(jResp,"value[i].DoNotUseSms")
        DoNotUseMail = CkJsonObject::ckBoolOf(jResp,"value[i].DoNotUseMail")
        Notes = CkJsonObject::ckStringOf(jResp,"value[i].Notes")
        Facebook = CkJsonObject::ckStringOf(jResp,"value[i].Facebook")
        LinkedIn = CkJsonObject::ckStringOf(jResp,"value[i].LinkedIn")
        Twitter = CkJsonObject::ckStringOf(jResp,"value[i].Twitter")
        FacebookId = CkJsonObject::ckStringOf(jResp,"value[i].FacebookId")
        LinkedInId = CkJsonObject::ckStringOf(jResp,"value[i].LinkedInId")
        TwitterId = CkJsonObject::ckStringOf(jResp,"value[i].TwitterId")
        ContactPhotoodata_mediaEditLink = CkJsonObject::ckStringOf(jResp,"value[i]." + Chr(34) + "ContactPhoto@odata.mediaEditLink" + Chr(34))
        ContactPhotoodata_mediaReadLink = CkJsonObject::ckStringOf(jResp,"value[i]." + Chr(34) + "ContactPhoto@odata.mediaReadLink" + Chr(34))
        ContactPhotoodata_mediaContentType = CkJsonObject::ckStringOf(jResp,"value[i]." + Chr(34) + "ContactPhoto@odata.mediaContentType" + Chr(34))
        TwitterAFDAId = CkJsonObject::ckStringOf(jResp,"value[i].TwitterAFDAId")
        FacebookAFDAId = CkJsonObject::ckStringOf(jResp,"value[i].FacebookAFDAId")
        LinkedInAFDAId = CkJsonObject::ckStringOf(jResp,"value[i].LinkedInAFDAId")
        PhotoId = CkJsonObject::ckStringOf(jResp,"value[i].PhotoId")
        GPSN = CkJsonObject::ckStringOf(jResp,"value[i].GPSN")
        GPSE = CkJsonObject::ckStringOf(jResp,"value[i].GPSE")
        Surname = CkJsonObject::ckStringOf(jResp,"value[i].Surname")
        GivenName = CkJsonObject::ckStringOf(jResp,"value[i].GivenName")
        MiddleName = CkJsonObject::ckStringOf(jResp,"value[i].MiddleName")
        Confirmed = CkJsonObject::ckBoolOf(jResp,"value[i].Confirmed")
        IsNonActualEmail = CkJsonObject::ckBoolOf(jResp,"value[i].IsNonActualEmail")
        Completeness = CkJsonObject::ckIntOf(jResp,"value[i].Completeness")
        LanguageId = CkJsonObject::ckStringOf(jResp,"value[i].LanguageId")
        Age = CkJsonObject::ckIntOf(jResp,"value[i].Age")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "$filter=Collection6%2FField6%20eq%20Id"
	-H "ForceUseSession: true"
	-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection3

Postman Collection Item JSON

{
  "name": "$filter parameter (eq operator) with Id",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "ForceUseSession",
        "type": "text",
        "value": "true"
      },
      {
        "key": "BPMCSRF",
        "type": "text",
        "value": "{{BPMCSRF}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{BaseURI}}/0/odata/{{CollectionName3}}?$filter={{CollectionName6}}/{{FieldName6}} eq {{ObjectId6}}",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "{{CollectionName3}}"
      ],
      "query": [
        {
          "key": "$filter",
          "value": "{{CollectionName6}}/{{FieldName6}} eq {{ObjectId6}}"
        }
      ]
    },
    "description": "Request for getting object collection instances, filtered by Id via the [$filter](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionfilter) parameter with the eq operator."
  },
  "response": [
    {
      "name": "[200] Gets filtered object collection instances by Id. The filter uses the “equal” operator",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "ForceUseSession",
            "type": "text",
            "value": "true"
          },
          {
            "key": "BPMCSRF",
            "type": "text",
            "value": "{{BPMCSRF}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "https://myserver.com/0/odata/Contact?$filter=Owner/Id eq 410006e1-ca4e-4502-a9ec-e54d922d2c00",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "Contact"
          ],
          "query": [
            {
              "key": "$filter",
              "value": "Owner/Id eq 410006e1-ca4e-4502-a9ec-e54d922d2c00"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Expires",
          "value": "-1"
        },
        {
          "key": "Server",
          "value": "Microsoft-IIS/10.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "X-AspNet-Version",
          "value": "4.0.30319"
        },
        {
          "key": "X-Powered-By",
          "value": "ASP.NET"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Date",
          "value": "Fri, 24 Jul 2020 07:16:54 GMT"
        },
        {
          "key": "Content-Length",
          "value": "7783"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Contact\",\n    \"value\": [\n        {\n            \"Id\": \"7aec3929-5d18-4086-ad7c-0fd9315e637a\",\n            \"Name\": \"Lynn A. Collins\",\n            \"OwnerId\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"CreatedOn\": \"2019-12-01T13:52:24Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2016-09-05T10:08:22Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"Dear\": \"\",\n            \"SalutationTypeId\": \"f4b32ee6-f36b-1410-aa84-00155d043204\",\n            \"GenderId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DecisionRoleId\": \"00000000-0000-0000-0000-000000000000\",\n            \"TypeId\": \"806732ee-f36b-1410-a883-16d83cab0980\",\n            \"JobId\": \"00000000-0000-0000-0000-000000000000\",\n            \"JobTitle\": \"\",\n            \"DepartmentId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BirthDate\": \"1991-03-20T00:00:00Z\",\n            \"Phone\": \"\",\n            \"MobilePhone\": \"\",\n            \"HomePhone\": \"\",\n            \"Skype\": \"\",\n            \"Email\": \"\",\n            \"AddressTypeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Address\": \"\",\n            \"CityId\": \"00000000-0000-0000-0000-000000000000\",\n            \"RegionId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Zip\": \"\",\n            \"CountryId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DoNotUseEmail\": true,\n            \"DoNotUseCall\": true,\n            \"DoNotUseFax\": true,\n            \"DoNotUseSms\": true,\n            \"DoNotUseMail\": true,\n            \"Notes\": \"\",\n            \"Facebook\": \"\",\n            \"LinkedIn\": \"\",\n            \"Twitter\": \"\",\n            \"FacebookId\": \"\",\n            \"LinkedInId\": \"\",\n            \"TwitterId\": \"\",\n            \"ContactPhoto@odata.mediaEditLink\": \"Contact(7aec3929-5d18-4086-ad7c-0fd9315e637a)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaReadLink\": \"Contact(7aec3929-5d18-4086-ad7c-0fd9315e637a)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaContentType\": \"application/octet-stream\",\n            \"TwitterAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"FacebookAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"LinkedInAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"PhotoId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GPSN\": \"\",\n            \"GPSE\": \"\",\n            \"Surname\": \"\",\n            \"GivenName\": \"\",\n            \"MiddleName\": \"\",\n            \"Confirmed\": false,\n            \"IsNonActualEmail\": false,\n            \"Completeness\": 15,\n            \"LanguageId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Age\": 29\n        },\n        {\n            \"Id\": \"bb843dd1-3802-424c-9c02-489702de9f1d\",\n            \"Name\": \"Administrator\",\n            \"OwnerId\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"CreatedOn\": \"2020-07-14T02:14:20.806177Z\",\n            \"CreatedById\": \"00000000-0000-0000-0000-000000000000\",\n            \"ModifiedOn\": \"2020-07-14T02:14:20.806177Z\",\n            \"ModifiedById\": \"00000000-0000-0000-0000-000000000000\",\n            \"ProcessListeners\": 0,\n            \"Dear\": \"\",\n            \"SalutationTypeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GenderId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"DecisionRoleId\": \"00000000-0000-0000-0000-000000000000\",\n            \"TypeId\": \"60733efc-f36b-1410-a883-16d83cab0980\",\n            \"JobId\": \"00000000-0000-0000-0000-000000000000\",\n            \"JobTitle\": \"\",\n            \"DepartmentId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BirthDate\": \"0001-01-01T00:00:00Z\",\n            \"Phone\": \"\",\n            \"MobilePhone\": \"\",\n            \"HomePhone\": \"\",\n            \"Skype\": \"\",\n            \"Email\": \"\",\n            \"AddressTypeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Address\": \"\",\n            \"CityId\": \"00000000-0000-0000-0000-000000000000\",\n            \"RegionId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Zip\": \"\",\n            \"CountryId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DoNotUseEmail\": false,\n            \"DoNotUseCall\": false,\n            \"DoNotUseFax\": false,\n            \"DoNotUseSms\": false,\n            \"DoNotUseMail\": false,\n            \"Notes\": \"\",\n            \"Facebook\": \"\",\n            \"LinkedIn\": \"\",\n            \"Twitter\": \"\",\n            \"FacebookId\": \"\",\n            \"LinkedInId\": \"\",\n            \"TwitterId\": \"\",\n            \"ContactPhoto@odata.mediaEditLink\": \"Contact(bb843dd1-3802-424c-9c02-489702de9f1d)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaReadLink\": \"Contact(bb843dd1-3802-424c-9c02-489702de9f1d)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaContentType\": \"application/octet-stream\",\n            \"TwitterAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"FacebookAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"LinkedInAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"PhotoId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GPSN\": \"\",\n            \"GPSE\": \"\",\n            \"Surname\": \"\",\n            \"GivenName\": \"\",\n            \"MiddleName\": \"\",\n            \"Confirmed\": false,\n            \"IsNonActualEmail\": false,\n            \"Completeness\": 0,\n            \"LanguageId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Age\": 0\n        },\n        {\n            \"Id\": \"c4ed336c-3e9b-40fe-8b82-5632476472b4\",\n            \"Name\": \"Andrew Baker (sample)\",\n            \"OwnerId\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"CreatedOn\": \"2018-06-04T12:13:18Z\",\n            \"CreatedById\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"ModifiedOn\": \"2016-09-15T14:27:21Z\",\n            \"ModifiedById\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"ProcessListeners\": 0,\n            \"Dear\": \"\",\n            \"SalutationTypeId\": \"7426ffb3-56e6-df11-971b-001d60e938c6\",\n            \"GenderId\": \"eeac42ee-65b6-df11-831a-001d60e938c6\",\n            \"AccountId\": \"405947d0-2ffb-4ded-8675-0475f19f5a81\",\n            \"DecisionRoleId\": \"f71ee81d-0cac-4e41-b7dc-9d4bd2e08491\",\n            \"TypeId\": \"00783ef6-f36b-1410-a883-16d83cab0980\",\n            \"JobId\": \"cb49a603-57e6-df11-971b-001d60e938c6\",\n            \"JobTitle\": \"Specialist\",\n            \"DepartmentId\": \"2076c4b6-7fe6-df11-971b-001d60e938c6\",\n            \"BirthDate\": \"1986-06-05T00:00:00Z\",\n            \"Phone\": \"+1 617 440 2031\",\n            \"MobilePhone\": \"+1 617 221 5187\",\n            \"HomePhone\": \"\",\n            \"Skype\": \"\",\n            \"Email\": \"a.baker@ac.com\",\n            \"AddressTypeId\": \"4f8b2d67-71d0-45fb-897e-cd4a308a97c0\",\n            \"Address\": \"39 Columbia Street\",\n            \"CityId\": \"74144617-a288-4984-bcac-e78733277a61\",\n            \"RegionId\": \"658acfe7-09ae-4747-b1b3-541e2dfa1b9e\",\n            \"Zip\": \"02112\",\n            \"CountryId\": \"e0be1264-f36b-1410-fa98-00155d043204\",\n            \"DoNotUseEmail\": false,\n            \"DoNotUseCall\": false,\n            \"DoNotUseFax\": false,\n            \"DoNotUseSms\": false,\n            \"DoNotUseMail\": false,\n            \"Notes\": \"\",\n            \"Facebook\": \"\",\n            \"LinkedIn\": \"\",\n            \"Twitter\": \"\",\n            \"FacebookId\": \"\",\n            \"LinkedInId\": \"\",\n            \"TwitterId\": \"\",\n            \"ContactPhoto@odata.mediaEditLink\": \"Contact(c4ed336c-3e9b-40fe-8b82-5632476472b4)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaReadLink\": \"Contact(c4ed336c-3e9b-40fe-8b82-5632476472b4)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaContentType\": \"application/octet-stream\",\n            \"TwitterAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"FacebookAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"LinkedInAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"PhotoId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GPSN\": \"\",\n            \"GPSE\": \"\",\n            \"Surname\": \"Baker\",\n            \"GivenName\": \"Andrew\",\n            \"MiddleName\": \"\",\n            \"Confirmed\": true,\n            \"IsNonActualEmail\": false,\n            \"Completeness\": 30,\n            \"LanguageId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Age\": 34\n        },\n        {\n            \"Id\": \"9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7\",\n            \"Name\": \"Mary King\",\n            \"OwnerId\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n            \"CreatedOn\": \"2020-02-04T12:43:53Z\",\n            \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ModifiedOn\": \"2016-09-05T10:08:22Z\",\n            \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n            \"ProcessListeners\": 0,\n            \"Dear\": \"King\",\n            \"SalutationTypeId\": \"f4b32ee6-f36b-1410-aa84-00155d043204\",\n            \"GenderId\": \"eeac42ee-65b6-df11-831a-001d60e938c6\",\n            \"AccountId\": \"e308b781-3c5b-4ecb-89ef-5c1ed4da488e\",\n            \"DecisionRoleId\": \"00000000-0000-0000-0000-000000000000\",\n            \"TypeId\": \"60733efc-f36b-1410-a883-16d83cab0980\",\n            \"JobId\": \"955472f0-56e6-df11-971b-001d60e938c6\",\n            \"JobTitle\": \"\",\n            \"DepartmentId\": \"2076c4b6-7fe6-df11-971b-001d60e938c6\",\n            \"BirthDate\": \"1981-09-05T00:00:00Z\",\n            \"Phone\": \"3020\",\n            \"MobilePhone\": \"\",\n            \"HomePhone\": \"\",\n            \"Skype\": \"\",\n            \"Email\": \"\",\n            \"AddressTypeId\": \"4f8b2d67-71d0-45fb-897e-cd4a308a97c0\",\n            \"Address\": \"73 Carson Road\",\n            \"CityId\": \"a1bf2e42-f36b-1410-0499-00155d043204\",\n            \"RegionId\": \"b1ae2e80-f36b-1410-3899-00155d043204\",\n            \"Zip\": \"\",\n            \"CountryId\": \"96ae123c-f46b-1410-f998-00155d043204\",\n            \"DoNotUseEmail\": true,\n            \"DoNotUseCall\": true,\n            \"DoNotUseFax\": true,\n            \"DoNotUseSms\": true,\n            \"DoNotUseMail\": true,\n            \"Notes\": \"\",\n            \"Facebook\": \"\",\n            \"LinkedIn\": \"\",\n            \"Twitter\": \"\",\n            \"FacebookId\": \"\",\n            \"LinkedInId\": \"\",\n            \"TwitterId\": \"\",\n            \"ContactPhoto@odata.mediaEditLink\": \"Contact(9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaReadLink\": \"Contact(9c2d2822-fc35-4ed5-a131-2f08bd4ab9f7)/ContactPhoto\",\n            \"ContactPhoto@odata.mediaContentType\": \"application/octet-stream\",\n            \"TwitterAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"FacebookAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"LinkedInAFDAId\": \"00000000-0000-0000-0000-000000000000\",\n            \"PhotoId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GPSN\": \"\",\n            \"GPSE\": \"\",\n            \"Surname\": \"\",\n            \"GivenName\": \"\",\n            \"MiddleName\": \"\",\n            \"Confirmed\": false,\n            \"IsNonActualEmail\": false,\n            \"Completeness\": 30,\n            \"LanguageId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Age\": 39\n        }\n    ]\n}"
    }
  ]
}