v1 > Services > MaterialsDelete

Delete one or more materials in Origin.

  • URL

    /connect/v1/materials/delete

    /connect/v1/async/materials/delete

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
materials[] array of object At least one The list of materials to delete Material object(s)
materials[].originId string Only if no materials[].externalId The material unique origin ID Any string
materials[].externalId string Only if no materials[].originId The material unique ID in your system Any string
  • Sample Request :
{
  "materials":[
    {
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79"
    }
  ]
}
  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'MATERIAL'
result.result object On success A simple completion message 'Delete completed.'
connectRequest object Always The exact request sent that produced this response A MaterialsDelete request

  • Sample Response (Success in sync mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"MATERIAL",
    "result":"Delete completed."
  },
  "connectRequest":{
    "materials":[
      {
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      }
    ]
  }
}
  • Response (async mode):
Field Type Presence Description Domain of value
status object Always The execution status A status object
status[].state string Always The state of execution 'SUCCESS' or 'ERROR'
status[].code string On error The general error code and message See Errors reference
status[].messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.poolingCallback string On success The URL callback to pool using the ResultGet endpoint A URL
connectRequest object Always The exact request you sent that produced this response A MaterialsCreate request

  • Sample Response (Success in async mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "poolingCallback":"https://origin.build/equinox/connect/v1/result/materials_delete/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest":{
    "materials":[
      {
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79"
      }
    ]
  }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
  "status":{
    "state":"ERROR",
    "code":"CE00001 - Connect request failed validation. Refer to provided messages for details.",
    "messages":[
      "materials[1] require one originId or externalId."
    ]
  },
  "connectRequest":{
    "materials":[
      {
       "locale":"en"
      }
    ]
  }
}

results matching ""

    No results matching ""