{"info":{"_postman_id":"c3ecea40-89bf-4083-9437-f04698baaf4f","name":"WEM Attributes Report","description":"

This report is available via RESTful web services and can be accessed using HTTP GET requests. All data returned is in JSON format. The report in WEMS MPI will no longer be available.

Please note that you must not be logged into the MPI while making the requests detailed in this section.

For support, contact: AEMO Real Time Market Submissions Team
Email: wa.operations@aemo.com.au

API status

Ready. The design is ready for participants to use.

Assumed knowledge

API and JSON or YAML basics.

\n\n

Prerequisites

Before you can use the Dispatch Case API you must:

Have a Participant ID. If your company is a Registered Participant, your ID is set up during the registration process.
Have a DigiCert TLS certificate.

For more information, see the Reformer page Accessing our test environments.

Request/response payload required limits

For all APIs, there is an enforced 10 MB max limit.

Certificate-based throttling

A single participant is restricted to accessing 50 calls every minute, with a total of 200 calls in five minutes.

API details

Use the API Reference icon at the top of the portal page to see the details of the paths, headers, request body and responses for each of the endpoints in the API.

Authentication methods

The Dispatch Case API uses the following authentication method:

DigiCert TLS certificate.

Base URLs

The base URLs used for this API are as follows:

Market trial: https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes
\n
Pre-prod: https://apis.preprod.aemo.com.au:9319/WEM/v1/attributes
\n
Production: https://apis.prod.aemo.com.au:9319/WEM/v1/attributes
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API status","slug":"api-status"},{"content":"Assumed knowledge","slug":"assumed-knowledge"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"Request/response payload required limits","slug":"requestresponse-payload-required-limits"},{"content":"Certificate-based throttling","slug":"certificate-based-throttling"},{"content":"API details","slug":"api-details"}],"owner":"26985380","collectionId":"c3ecea40-89bf-4083-9437-f04698baaf4f","publishedId":"2s9Y5eLyWw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-09-03T23:32:09.000Z"},"item":[{"name":"{tradingDate}","item":[{"name":"Get a list of attributes by date","id":"0143307f-9d69-4753-901b-d7cd0f73bedf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","description":"

Get a list of attributes by date

\n","urlObject":{"path":[":tradingDate"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"query":[],"variable":[{"id":"a5160852-69c9-4c95-803c-d77cfe5c9aa3","type":"any","value":"2023-01-25","key":"tradingDate"}]}},"response":[{"id":"3eb39f35-d350-48a4-be64-142711d04ca4","name":"List of attributes","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"value\": \"\",\n \"unit\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"value\": \"\",\n \"unit\": \"\"\n }\n]"},{"id":"69b7f024-cb30-4ac8-b052-92d74bfecdd6","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"d8646fcf-861f-4ed1-b039-9313e84ac441","name":"Method not allowed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"11fe1551-8ec8-4f89-822e-821be482043d","name":"Payload Too Large","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"Request Entity Too Large","code":413,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"b2c9c555-eca6-453a-9634-a2de8acb224f","name":"Too many request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"7f180a5f-0450-479c-a0e6-12c84bc6c383","name":"Application unavailable","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/:tradingDate","host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"path":[":tradingDate"],"variable":[{"key":"tradingDate"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"examples\": {\n \"applicationUnavailable\": {\n \"summary\": \"Application Unavailable\"\n }\n }\n}"}],"_postman_id":"0143307f-9d69-4753-901b-d7cd0f73bedf"}],"id":"e256b303-0f34-48d5-be1a-77e92f87bb10","_postman_id":"e256b303-0f34-48d5-be1a-77e92f87bb10","description":""},{"name":"current","item":[{"name":"Get a list of attributes for today","id":"353d5fc2-039d-43e1-b0d2-642dadd02586","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current","description":"

Get a list of attributes for today

\n","urlObject":{"path":["current"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"],"query":[],"variable":[]}},"response":[{"id":"431621f7-c10d-4a1d-9e36-af7c6e590427","name":"List of attributes","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"value\": \"\",\n \"unit\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"value\": \"\",\n \"unit\": \"\"\n }\n]"},{"id":"c6f4a6d4-ced2-4715-8e30-0a7d1b314e27","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"823e8a27-d3df-4275-a72b-92e113b457dd","name":"Method not allowed","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"5909c454-4b2c-46ca-85f3-ca2d7d249d79","name":"Payload Too Large","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"Request Entity Too Large","code":413,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"b726c586-4608-431e-91df-5aeb18bed7ba","name":"Too many request","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"source\": {},\n \"title\": \"\"\n }\n ]\n}"},{"id":"ed9a7eb5-3e9e-4fda-ab26-86021d42ac81","name":"Application unavailable","originalRequest":{"method":"GET","header":[],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes/current"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"examples\": {\n \"applicationUnavailable\": {\n \"summary\": \"Application Unavailable\"\n }\n }\n}"}],"_postman_id":"353d5fc2-039d-43e1-b0d2-642dadd02586"}],"id":"0f59ad2b-545f-4a16-960f-a137615277f1","_postman_id":"0f59ad2b-545f-4a16-960f-a137615277f1","description":""}],"event":[{"listen":"prerequest","script":{"id":"43b60545-a062-41c2-aec4-788eea6b9b54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b77febf9-b69b-4b0e-aa31-d9c159e67a48","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://apis.rfm.aemo.com.au:9319/WEM/v1/attributes"}]}