Resources Apply Requests

Resources Apply Request: Create (Account)

Create a request to asynchronously apply resources using the URL of a GitHub repository.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

targetAccountId required	string ID for the account which the resources will be applied to.
required	object This is an object containing the information about where the Resources are located. The attributes in this object include type, url and variables.

Responses

Request samples

Payload

Content type

application/json

{"targetAccountId": "B093879",
"source": {"type": "GitHub",
"url": "https://github.com/YextSolutions/basic-free-trial",
"variables": {"title": "Yext source"
}
}
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"id": 13027,
"targetAccountId": "B093879",
"status": "COMPLETE",
"dateSubmitted": "2017-05-10T19:23:07",
"dateCompleted": "2017-05-10T19:31:29",
"source": {"type": "GITHUB",
"url": "https://github.com/YextSolutions/basic-free-trial",
"variables": {"title": "Yext source"
}
}
}
}

Resources Apply Request Status: Get (Account)

Make a request to get the status of the Resources Apply Request.

path Parameters

requestId required	integer requestId returned from a previous call to Resources Apply Requests: Create (Account)
accountId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"id": 13027,
"targetAccountId": "B093879",
"status": "COMPLETE",
"dateSubmitted": "2017-05-10T19:23:07",
"dateCompleted": "2017-05-10T19:31:29",
"source": {"type": "GITHUB",
"url": "https://github.com/YextSolutions/basic-free-trial",
"variables": {"title": "Yext source"
}
}
}
}