v1 > Services > MaterialsSearch

Search one or more materials in Origin. The search result is organized in pages.

• URL

  /connect/v1/materials/search

• Method:

  POST

• URL Params

  none

• Request :

• Sample Request :

This sample request could be translated as : "Search the material with ORIGINID value of db65ac6b-5850-11e8-803c-8c16451835eb starting from page 1 with 10 results by page."

{
    "locale": "en",
    "pageNumber": "1",
    "pageSize": "10",
    "searchCriteria": [
        {
            "name": "ORIGINID",
            "value": "db65ac6b-5850-11e8-803c-8c16451835eb"
        }
    ]
}

• Response :

• Sample Response (Success):

  HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"MATERIAL",
    "searchInfo":{
      "numberOfElements":"1",
      "numberOfPages":"1"
    },
    "data":[
      {
        "locale":"en",
        "originId":"93bcbf18-51fb-11e8-8716-8c16451835eb",
        "externalId":"00006060-8ebf-4a0f-94a5-de7c949a1a28",
        "productId": "refcode001",
        "managementPermission": "COMPANY_READONLY",
        "name":"XYZ Modular",
        "description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut tincidunt orci eget lacus dignissim bibendum.",
        "contentManagedBy": "John Smith",
        "lastUpdated": "2018-11-06T13:20:30Z",        
        "brand":{
          "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
          "name":"XYZ Modular Furniture",
          "website": "https://www.xyzmodfurniture.tld"
        },
        "logoUrl":{
          "originalUrl": "https://www.xyzmodfurniture.tld/public/img/xyzmod/XYZ-asset-image-0-4444.jpeg",
          "referenceUrl":"https://origin.build/equinox/storage/public/XYZ-asset-image-0-4444.jpeg"
        },
        "company":{
          "originId":"101dd127-90d0-4123-9981-37998ceaa317",
          "name":"GIGA",
          "companyType": "MANUFACTURER"
        },
        "collection": {
          "name": "My fall collection"
        },
        "libraries": [
          {
            "originId": "c254638f-1fde-4ca8-ae1f-8fb5abbfe8dd",
            "name": "My library"
          }
        ],
        "category":{
          "name":"Seating",
          "code": "gc_3"
        },
        "csiDivisions": [
          {
            "code": "12 58 29",
            "name": "Beds"
          }
        ],
        "idealProjects":[
          {
            "value":"Commercial"
          },
          {
            "value":"Residential"
          }
        ],
        "images":[
          {
            "originalUrl": "https://www.xyzmodfurniture.tld/public/img/xyzmod/XYZ-asset-image-0-4444.jpeg",
            "referenceUrl":"https://origin.build/equinox/storage/public/XYZ-asset-image-0-4444.jpeg"
          }
        ],
        "additionalsDocuments": [
          {
            "originalUrl": "https://www.xyzmodfurniture.tld/public/doc/xyzmod/xyzmod001.txt",
            "referenceUrl": "https://origin.build/equinox/storage/public/xyzmod001.txt"
          },
          {
            "originalUrl": "https://www.xyzmodfurniture.tld/public/doc/xyzmod/xyzmod002.txt",
            "referenceUrl": "https://origin.build/equinox/storage/public/xyzmod002.txt"
          }
        ],
        "contacts": [
          {
            "externalId": "JOHNSMITHVENDOR1",
            "type": "VENDOR",
            "name": "John Smith",
            "companyName": "ACME Inc.",
            "website": "https://www.acme.com/",
            "postalAddress": "2500 Street Avenues",
            "phone": "1-999-123-1234",
            "email": "salesrep@acme.com"
          }
        ],
        "tags": [
          {
            "name": "xyz"
          }
        ],
        "connectedCertifications": [
          {
            "originId": "6e7bcbfe-4d82-42ad-aa62-6c8d9b142a73"
          },
          {
            "originId": "a78a0a24-5829-4723-bde6-0ccf565a6f3c"
          },
          {
            "originId": "e7917326-1055-460a-8118-1bc0c48121bd"
          }
        ],
        "connectedDeclarations": [
          {
            "originId": "4184443c-0c0d-405c-9a5e-125256b62afe"
          },
          {
            "originId": "5d29b08c-2174-499a-a752-463a9c60d9bf"
          }
        ],
        "connectedTestReports": [
          {
            "originId": "71072fb6-6616-4658-b440-beeac537a97b"
          }
        ],
        "url": "https://www.xyzmodfurniture.tld/xyzmod.html",
        "originUrl":"https://origin.build/#/material/93bcbf18-51fb-11e8-8716-8c16451835eb?locale=en"
      }
    ]
  },
  "connectRequest":{
    "locale":"en",
    "pageNumber":"1",
    "pageSize":"100",
    "searchCriteria":[
      {
        "name":"ORIGINID",
        "value":"93bcbf18-51fb-11e8-8716-8c16451835eb"
      }
    ]
  }
}

• Sample Response (Error):

  HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value '0' for field pageNumber. Allowed value(s) : [positive integer not equal zero]",
            "searchCriteria[1] has invalid value 'ORIGIN_IDENT' for field name. Allowed value(s) : [COMPANYID,LIBRARYID,KEYWORD,EXTERNALID,ORIGINID,MODIFIEDSINCE]"
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "0",
        "pageSize": "1",
        "searchCriteria": [
            {
                "name": "ORIGIN_IDENT",
                "value": "93bcbf18-51fb-11e8-8716-8c16451835eb"
            }
        ]
    }
}